{ "openapi" : "3.0.1", "info" : { "title" : "USIC JSON API", "description" : "Application Programming Interface for USIC.\r\n The USIC API adheres to the [{json:api} specification](http://jsonapi.org/) for building APIs in JSON.", "contact" : { "name" : "Steven Pothoven", "email" : "stevenpothoven@usicllc.com" }, "version" : "1.0.0" }, "servers" : [ { "url" : "https://jsonapi-dev.usicllc.com", "description" : "Development" }, { "url" : "https://jsonapi-staging.usicllc.com", "description" : "Test" }, { "url" : "https://jsonapi.usicllc.com", "description" : "Production" } ], "security" : [ { "JWT" : [ ] } ], "tags" : [ { "name" : "unauthorized", "description" : "operations available without authorization" } ], "paths" : { "/auth" : { "post" : { "tags" : [ "unauthorized" ], "description" : "Login to the API", "requestBody" : { "content" : { "application/json" : { "schema" : { "required" : [ "password", "username" ], "properties" : { "password" : { "type" : "string", "format" : "password", "example" : "secret", "exampleSetFlag" : true }, "username" : { "type" : "string", "example" : "username@usicllc.com", "exampleSetFlag" : true } }, "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "required" : [ "token" ], "type" : "object", "properties" : { "token" : { "type" : "string", "exampleSetFlag" : false } }, "exampleSetFlag" : false }, "exampleSetFlag" : false } } } } } }, "/assetmanager/1.0/assetCategoryTypes/{id}" : { "get" : { "description" : "Retrieve a assetCategoryTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoryTypesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetCategoryTypesFields" }, { "$ref" : "#/components/parameters/AssetCategoryTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetCategoryTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoryTypesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetCategoryTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoryTypesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetCategoryTypes" : { "get" : { "description" : "Retrieve a List of assetCategoryTypes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMappings]", "in" : "query", "description" : "Filter by categoryTypeMakeMappings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetCategoryTypesFields" }, { "$ref" : "#/components/parameters/AssetCategoryTypesInclude" }, { "$ref" : "#/components/parameters/AssetCategoryTypesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetCategoryTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetCategoryTypes/{id}/categoryTypeMakeMappings" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings related to a assetCategoryTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoryTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_id]", "in" : "query", "description" : "Filter by type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_type_id]", "in" : "query", "description" : "Filter by category_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategory]", "in" : "query", "description" : "Filter by assetCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategoryType]", "in" : "query", "description" : "Filter by assetCategoryType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetCategoryTypes/{id}/relationships/categoryTypeMakeMappings" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings references related to a assetCategoryTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoryTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_id]", "in" : "query", "description" : "Filter by type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_type_id]", "in" : "query", "description" : "Filter by category_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategory]", "in" : "query", "description" : "Filter by assetCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategoryType]", "in" : "query", "description" : "Filter by assetCategoryType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}" : { "get" : { "description" : "Retrieve a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationVersionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a InvestigationVersions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a InvestigationVersions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationVersionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions" : { "get" : { "description" : "Retrieve a List of investigationVersions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approverEmployee]", "in" : "query", "description" : "Filter by approverEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenByEmployee]", "in" : "query", "description" : "Filter by picsTakenByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationVersionsInclude" }, { "$ref" : "#/components/parameters/InvestigationVersionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationVersionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a InvestigationVersions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationVersionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/approverEmployee" : { "get" : { "description" : "Retrieve employees related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/picsTakenByEmployee" : { "get" : { "description" : "Retrieve employees related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/investigationDetailsVersions" : { "get" : { "description" : "Retrieve investigationDetailsVersions related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersion]", "in" : "query", "description" : "Filter by investigationVersion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completedBy]", "in" : "query", "description" : "Filter by completedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changedBy]", "in" : "query", "description" : "Filter by changedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/relationships/approverEmployee" : { "get" : { "description" : "Retrieve employees references related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/relationships/picsTakenByEmployee" : { "get" : { "description" : "Retrieve employees references related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationVersions/{id}/relationships/investigationDetailsVersions" : { "get" : { "description" : "Retrieve investigationDetailsVersions references related to a investigationVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersion]", "in" : "query", "description" : "Filter by investigationVersion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completedBy]", "in" : "query", "description" : "Filter by completedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changedBy]", "in" : "query", "description" : "Filter by changedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccesses/{id}" : { "get" : { "description" : "Retrieve a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/UserAccessesFields" }, { "$ref" : "#/components/parameters/UserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccesses" : { "get" : { "description" : "Retrieve a List of userAccesses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_states]", "in" : "query", "description" : "Filter by customer_states (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccessesFields" }, { "$ref" : "#/components/parameters/UserAccessesInclude" }, { "$ref" : "#/components/parameters/UserAccessesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccesses/{id}/user" : { "get" : { "description" : "Retrieve users related to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/UsersFields" }, { "$ref" : "#/components/parameters/UsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userAccesses relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userAccesses relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userAccesses relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccesses/{id}/customerContract" : { "get" : { "description" : "Retrieve customerContracts related to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccesses/{id}/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts related to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccesses/{id}/relationships/user" : { "get" : { "description" : "Retrieve users references related to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/UsersFields" }, { "$ref" : "#/components/parameters/UsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userAccesses relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userAccesses relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userAccesses relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccesses/{id}/relationships/customerContract" : { "get" : { "description" : "Retrieve customerContracts references related to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccesses/{id}/relationships/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts references related to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}" : { "get" : { "description" : "Retrieve a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/BillableCustomersFields" }, { "$ref" : "#/components/parameters/BillableCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BillableCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a BillableCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a BillableCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BillableCustomersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers" : { "get" : { "description" : "Retrieve a List of billableCustomers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_customers_group_id]", "in" : "query", "description" : "Filter by billable_customers_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_id]", "in" : "query", "description" : "Filter by contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_by_category_id]", "in" : "query", "description" : "Filter by notified_by_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[not_billable]", "in" : "query", "description" : "Filter by not_billable (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_photos_required]", "in" : "query", "description" : "Filter by inv_photos_required (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[days_to_send_report]", "in" : "query", "description" : "Filter by days_to_send_report (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by_id]", "in" : "query", "description" : "Filter by last_updated_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastUpdatedBy]", "in" : "query", "description" : "Filter by lastUpdatedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[createdBy]", "in" : "query", "description" : "Filter by createdBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/BillableCustomersFields" }, { "$ref" : "#/components/parameters/BillableCustomersInclude" }, { "$ref" : "#/components/parameters/BillableCustomersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BillableCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a BillableCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BillableCustomersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BillableCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/facility" : { "get" : { "description" : "Retrieve facilities related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/FacilitiesFields" }, { "$ref" : "#/components/parameters/FacilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FacilitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/FacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/lastUpdatedBy" : { "get" : { "description" : "Retrieve employees related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/createdBy" : { "get" : { "description" : "Retrieve employees related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/state" : { "get" : { "description" : "Retrieve states related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/relationships/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers references related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/relationships/facility" : { "get" : { "description" : "Retrieve facilities references related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/FacilitiesFields" }, { "$ref" : "#/components/parameters/FacilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FacilitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/relationships/lastUpdatedBy" : { "get" : { "description" : "Retrieve employees references related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/relationships/createdBy" : { "get" : { "description" : "Retrieve employees references related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/billableCustomers/{id}/relationships/state" : { "get" : { "description" : "Retrieve states references related to a billableCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BillableCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/wsvLocByContracts/{id}" : { "get" : { "description" : "Retrieve a wsvLocByContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsvLocByContractsPrimaryKey" }, { "$ref" : "#/components/parameters/WsvLocByContractsFields" }, { "$ref" : "#/components/parameters/WsvLocByContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsvLocByContractsResourceResponse" }, "202" : { "$ref" : "#/components/responses/WsvLocByContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a WsvLocByContracts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsvLocByContractsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/WsvLocByContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a WsvLocByContracts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsvLocByContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocByContractsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WsvLocByContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/wsvLocByContracts" : { "get" : { "description" : "Retrieve a List of wsvLocByContracts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[oPENED_CT]", "in" : "query", "description" : "Filter by oPENED_CT (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cLOSED_CT]", "in" : "query", "description" : "Filter by cLOSED_CT (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cAL_YEAR]", "in" : "query", "description" : "Filter by cAL_YEAR (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cAL_MONTH]", "in" : "query", "description" : "Filter by cAL_MONTH (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cAL_WEEK_YEAR]", "in" : "query", "description" : "Filter by cAL_WEEK_YEAR (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cAL_WEEK_IN_YEAR]", "in" : "query", "description" : "Filter by cAL_WEEK_IN_YEAR (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cALENDAR_DATE]", "in" : "query", "description" : "Filter by cALENDAR_DATE (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[aCCOUNT_NAME]", "in" : "query", "description" : "Filter by aCCOUNT_NAME (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[aCCOUNT_NUMBER]", "in" : "query", "description" : "Filter by aCCOUNT_NUMBER (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cONTRACT_NUMBER]", "in" : "query", "description" : "Filter by cONTRACT_NUMBER (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rOW_CHECKSUM]", "in" : "query", "description" : "Filter by rOW_CHECKSUM (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cREATED_DTTM]", "in" : "query", "description" : "Filter by cREATED_DTTM (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WsvLocByContractsFields" }, { "$ref" : "#/components/parameters/WsvLocByContractsInclude" }, { "$ref" : "#/components/parameters/WsvLocByContractsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsvLocByContractsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WsvLocByContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a WsvLocByContracts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocByContractsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocByContractsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WsvLocByContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetCategories/{id}" : { "get" : { "description" : "Retrieve a assetCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetCategoriesFields" }, { "$ref" : "#/components/parameters/AssetCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetCategories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoriesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetCategories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetCategories" : { "get" : { "description" : "Retrieve a List of assetCategories resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMappings]", "in" : "query", "description" : "Filter by categoryTypeMakeMappings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetCategoriesFields" }, { "$ref" : "#/components/parameters/AssetCategoriesInclude" }, { "$ref" : "#/components/parameters/AssetCategoriesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetCategories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetCategories/{id}/categoryTypeMakeMappings" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings related to a assetCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_id]", "in" : "query", "description" : "Filter by type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_type_id]", "in" : "query", "description" : "Filter by category_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategory]", "in" : "query", "description" : "Filter by assetCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategoryType]", "in" : "query", "description" : "Filter by assetCategoryType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetCategories/{id}/relationships/categoryTypeMakeMappings" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings references related to a assetCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_id]", "in" : "query", "description" : "Filter by type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_type_id]", "in" : "query", "description" : "Filter by category_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategory]", "in" : "query", "description" : "Filter by assetCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategoryType]", "in" : "query", "description" : "Filter by assetCategoryType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas/{id}" : { "get" : { "description" : "Retrieve a ideas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" }, { "$ref" : "#/components/parameters/IdeasFields" }, { "$ref" : "#/components/parameters/IdeasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeasResourceResponse" }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Ideas", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Ideas", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeasPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas" : { "get" : { "description" : "Retrieve a List of ideas resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[content]", "in" : "query", "description" : "Filter by content (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[kind_id]", "in" : "query", "description" : "Filter by kind_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[author_id]", "in" : "query", "description" : "Filter by author_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_or_rejected_on]", "in" : "query", "description" : "Filter by approved_or_rejected_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_or_rejected_by]", "in" : "query", "description" : "Filter by approved_or_rejected_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[kind]", "in" : "query", "description" : "Filter by kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[comments]", "in" : "query", "description" : "Filter by comments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[votes]", "in" : "query", "description" : "Filter by votes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/IdeasFields" }, { "$ref" : "#/components/parameters/IdeasInclude" }, { "$ref" : "#/components/parameters/IdeasSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeasResourcesResponse" }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Ideas", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeasPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeasResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a ideas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas/{id}/kind" : { "get" : { "description" : "Retrieve ideaKinds related to a ideas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" }, { "$ref" : "#/components/parameters/IdeaKindsFields" }, { "$ref" : "#/components/parameters/IdeaKindsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeaKindsResourceResponse" }, "202" : { "$ref" : "#/components/responses/IdeaKindsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas/{id}/comments" : { "get" : { "description" : "Retrieve comments related to a ideas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[content]", "in" : "query", "description" : "Filter by content (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea_id]", "in" : "query", "description" : "Filter by idea_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[author_id]", "in" : "query", "description" : "Filter by author_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea]", "in" : "query", "description" : "Filter by idea (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CommentsFields" }, { "$ref" : "#/components/parameters/CommentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CommentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas/{id}/votes" : { "get" : { "description" : "Retrieve votes related to a ideas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vote_type]", "in" : "query", "description" : "Filter by vote_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea_id]", "in" : "query", "description" : "Filter by idea_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voter_id]", "in" : "query", "description" : "Filter by voter_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea]", "in" : "query", "description" : "Filter by idea (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VotesFields" }, { "$ref" : "#/components/parameters/VotesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VotesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a ideas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas/{id}/relationships/kind" : { "get" : { "description" : "Retrieve ideaKinds references related to a ideas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" }, { "$ref" : "#/components/parameters/IdeaKindsFields" }, { "$ref" : "#/components/parameters/IdeaKindsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeaKindsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/IdeaKindsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas/{id}/relationships/comments" : { "get" : { "description" : "Retrieve comments references related to a ideas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[content]", "in" : "query", "description" : "Filter by content (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea_id]", "in" : "query", "description" : "Filter by idea_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[author_id]", "in" : "query", "description" : "Filter by author_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea]", "in" : "query", "description" : "Filter by idea (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CommentsFields" }, { "$ref" : "#/components/parameters/CommentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideas/{id}/relationships/votes" : { "get" : { "description" : "Retrieve votes references related to a ideas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeasPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vote_type]", "in" : "query", "description" : "Filter by vote_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea_id]", "in" : "query", "description" : "Filter by idea_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voter_id]", "in" : "query", "description" : "Filter by voter_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea]", "in" : "query", "description" : "Filter by idea (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VotesFields" }, { "$ref" : "#/components/parameters/VotesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VotesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/states/{id}" : { "get" : { "description" : "Retrieve a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatesPrimaryKey" }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "delete" : { "description" : "Delete a States", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a States", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/states" : { "get" : { "description" : "Retrieve a List of states resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[abbrev]", "in" : "query", "description" : "Filter by abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locations]", "in" : "query", "description" : "Filter by locations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" }, { "$ref" : "#/components/parameters/StatesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create a States", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/states/{id}/locations" : { "get" : { "description" : "Retrieve locations related to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_type_id]", "in" : "query", "description" : "Filter by location_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_id]", "in" : "query", "description" : "Filter by country_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districts]", "in" : "query", "description" : "Filter by districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/shareddata/1.0/states/{id}/country" : { "get" : { "description" : "Retrieve countries related to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatesPrimaryKey" }, { "$ref" : "#/components/parameters/CountriesFields" }, { "$ref" : "#/components/parameters/CountriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/shareddata/1.0/states/{id}/relationships/locations" : { "get" : { "description" : "Retrieve locations references related to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_type_id]", "in" : "query", "description" : "Filter by location_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_id]", "in" : "query", "description" : "Filter by country_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districts]", "in" : "query", "description" : "Filter by districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/shareddata/1.0/states/{id}/relationships/country" : { "get" : { "description" : "Retrieve countries references related to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatesPrimaryKey" }, { "$ref" : "#/components/parameters/CountriesFields" }, { "$ref" : "#/components/parameters/CountriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/cms/1.0/approverListings/{id}" : { "get" : { "description" : "Retrieve a approverListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApproverListingsPrimaryKey" }, { "$ref" : "#/components/parameters/ApproverListingsFields" }, { "$ref" : "#/components/parameters/ApproverListingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApproverListingsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ApproverListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ApproverListings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApproverListingsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ApproverListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ApproverListings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApproverListingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApproverListingsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ApproverListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/approverListings" : { "get" : { "description" : "Retrieve a List of approverListings resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_title]", "in" : "query", "description" : "Filter by job_title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ApproverListingsFields" }, { "$ref" : "#/components/parameters/ApproverListingsInclude" }, { "$ref" : "#/components/parameters/ApproverListingsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApproverListingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ApproverListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ApproverListings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApproverListingsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApproverListingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ApproverListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/approverListings/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a approverListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApproverListingsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/approverListings/{id}/district" : { "get" : { "description" : "Retrieve districts related to a approverListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApproverListingsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/approverListings/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a approverListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApproverListingsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/approverListings/{id}/relationships/district" : { "get" : { "description" : "Retrieve districts references related to a approverListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApproverListingsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}" : { "get" : { "description" : "Retrieve a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourceResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Visits", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Visits", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits" : { "get" : { "description" : "Retrieve a List of visits resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[arrived]", "in" : "query", "description" : "Filter by arrived (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[departed]", "in" : "query", "description" : "Filter by departed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[synced_up]", "in" : "query", "description" : "Filter by synced_up (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_saved_local]", "in" : "query", "description" : "Filter by when_saved_local (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[photo_ident]", "in" : "query", "description" : "Filter by photo_ident (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[actor_id]", "in" : "query", "description" : "Filter by actor_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[opened]", "in" : "query", "description" : "Filter by opened (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visitLocation]", "in" : "query", "description" : "Filter by visitLocation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" }, { "$ref" : "#/components/parameters/VisitsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Visits", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/visitLocation" : { "get" : { "description" : "Retrieve visitLocations related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/VisitLocationsFields" }, { "$ref" : "#/components/parameters/VisitLocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitLocationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/VisitLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/tkpDistrict" : { "get" : { "description" : "Retrieve tkpDistricts related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpDistrictsFields" }, { "$ref" : "#/components/parameters/TkpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpDistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/activities" : { "get" : { "description" : "Retrieve activities related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/dueDateExtensions" : { "get" : { "description" : "Retrieve dueDateExtensions related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr_id]", "in" : "query", "description" : "Filter by usr_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_extended]", "in" : "query", "description" : "Filter by when_extended (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[due_date]", "in" : "query", "description" : "Filter by due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver_phone]", "in" : "query", "description" : "Filter by approver_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[old_due_date]", "in" : "query", "description" : "Filter by old_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_entered]", "in" : "query", "description" : "Filter by when_entered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsFields" }, { "$ref" : "#/components/parameters/DueDateExtensionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DueDateExtensionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/relationships/visitLocation" : { "get" : { "description" : "Retrieve visitLocations references related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/VisitLocationsFields" }, { "$ref" : "#/components/parameters/VisitLocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitLocationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VisitLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/relationships/tkpDistrict" : { "get" : { "description" : "Retrieve tkpDistricts references related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpDistrictsFields" }, { "$ref" : "#/components/parameters/TkpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/relationships/activities" : { "get" : { "description" : "Retrieve activities references related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visits/{id}/relationships/dueDateExtensions" : { "get" : { "description" : "Retrieve dueDateExtensions references related to a visits resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr_id]", "in" : "query", "description" : "Filter by usr_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_extended]", "in" : "query", "description" : "Filter by when_extended (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[due_date]", "in" : "query", "description" : "Filter by due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver_phone]", "in" : "query", "description" : "Filter by approver_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[old_due_date]", "in" : "query", "description" : "Filter by old_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_entered]", "in" : "query", "description" : "Filter by when_entered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsFields" }, { "$ref" : "#/components/parameters/DueDateExtensionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profiles/{id}" : { "get" : { "description" : "Retrieve a profiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfilesPrimaryKey" }, { "$ref" : "#/components/parameters/ProfilesFields" }, { "$ref" : "#/components/parameters/ProfilesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Profiles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfilesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Profiles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfilesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profiles" : { "get" : { "description" : "Retrieve a List of profiles resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profileValues]", "in" : "query", "description" : "Filter by profileValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ProfilesFields" }, { "$ref" : "#/components/parameters/ProfilesInclude" }, { "$ref" : "#/components/parameters/ProfilesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Profiles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profiles/{id}/profileValues" : { "get" : { "description" : "Retrieve profileValues related to a profiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfilesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_id]", "in" : "query", "description" : "Filter by profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_level_id]", "in" : "query", "description" : "Filter by profile_level_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value_data_type]", "in" : "query", "description" : "Filter by value_data_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile]", "in" : "query", "description" : "Filter by profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profileLevel]", "in" : "query", "description" : "Filter by profileLevel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ProfileValuesFields" }, { "$ref" : "#/components/parameters/ProfileValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileValuesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profiles/{id}/relationships/profileValues" : { "get" : { "description" : "Retrieve profileValues references related to a profiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfilesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_id]", "in" : "query", "description" : "Filter by profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_level_id]", "in" : "query", "description" : "Filter by profile_level_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value_data_type]", "in" : "query", "description" : "Filter by value_data_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile]", "in" : "query", "description" : "Filter by profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profileLevel]", "in" : "query", "description" : "Filter by profileLevel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ProfileValuesFields" }, { "$ref" : "#/components/parameters/ProfileValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/utilitiesProfiles/{id}" : { "get" : { "description" : "Retrieve a utilitiesProfiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilitiesProfilesPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesProfilesFields" }, { "$ref" : "#/components/parameters/UtilitiesProfilesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UtilitiesProfiles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilitiesProfilesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UtilitiesProfiles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilitiesProfilesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesProfilesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/utilitiesProfiles" : { "get" : { "description" : "Retrieve a List of utilitiesProfiles resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type]", "in" : "query", "description" : "Filter by facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type]", "in" : "query", "description" : "Filter by utility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UtilitiesProfilesFields" }, { "$ref" : "#/components/parameters/UtilitiesProfilesInclude" }, { "$ref" : "#/components/parameters/UtilitiesProfilesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesProfilesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UtilitiesProfiles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesProfilesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventoryUsageSummaries/{id}" : { "get" : { "description" : "Retrieve a verizonWirelessInventoryUsageSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a VerizonWirelessInventoryUsageSummaries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a VerizonWirelessInventoryUsageSummaries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventoryUsageSummaries" : { "get" : { "description" : "Retrieve a List of verizonWirelessInventoryUsageSummaries resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mdn]", "in" : "query", "description" : "Filter by mdn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_date]", "in" : "query", "description" : "Filter by usage_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acct_no]", "in" : "query", "description" : "Filter by acct_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sub_acct_no]", "in" : "query", "description" : "Filter by sub_acct_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_minutes]", "in" : "query", "description" : "Filter by usage_minutes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_bytes]", "in" : "query", "description" : "Filter by usage_bytes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_sms]", "in" : "query", "description" : "Filter by usage_sms (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[verizonWirelessInventoryUsages]", "in" : "query", "description" : "Filter by verizonWirelessInventoryUsages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesInclude" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a VerizonWirelessInventoryUsageSummaries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventoryUsageSummaries/{id}/verizonWirelessInventoryUsages" : { "get" : { "description" : "Retrieve verizonWirelessInventoryUsages related to a verizonWirelessInventoryUsageSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acct_no]", "in" : "query", "description" : "Filter by acct_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sub_acct_no]", "in" : "query", "description" : "Filter by sub_acct_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mdn]", "in" : "query", "description" : "Filter by mdn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_date]", "in" : "query", "description" : "Filter by usage_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_time]", "in" : "query", "description" : "Filter by usage_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_type]", "in" : "query", "description" : "Filter by usage_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_count]", "in" : "query", "description" : "Filter by usage_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[overseas_ind]", "in" : "query", "description" : "Filter by overseas_ind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[incoming_direction_ind]", "in" : "query", "description" : "Filter by incoming_direction_ind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dialed_digits]", "in" : "query", "description" : "Filter by dialed_digits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roaming_ind]", "in" : "query", "description" : "Filter by roaming_ind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roaming_provider]", "in" : "query", "description" : "Filter by roaming_provider (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_code]", "in" : "query", "description" : "Filter by country_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[duration_time]", "in" : "query", "description" : "Filter by duration_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sequence_num]", "in" : "query", "description" : "Filter by sequence_num (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_type]", "in" : "query", "description" : "Filter by data_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filler]", "in" : "query", "description" : "Filter by filler (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[verizonWirelessInventoryUsageSummary]", "in" : "query", "description" : "Filter by verizonWirelessInventoryUsageSummary (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventoryUsageSummaries/{id}/relationships/verizonWirelessInventoryUsages" : { "get" : { "description" : "Retrieve verizonWirelessInventoryUsages references related to a verizonWirelessInventoryUsageSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acct_no]", "in" : "query", "description" : "Filter by acct_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sub_acct_no]", "in" : "query", "description" : "Filter by sub_acct_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mdn]", "in" : "query", "description" : "Filter by mdn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_date]", "in" : "query", "description" : "Filter by usage_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_time]", "in" : "query", "description" : "Filter by usage_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_type]", "in" : "query", "description" : "Filter by usage_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_count]", "in" : "query", "description" : "Filter by usage_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[overseas_ind]", "in" : "query", "description" : "Filter by overseas_ind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[incoming_direction_ind]", "in" : "query", "description" : "Filter by incoming_direction_ind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dialed_digits]", "in" : "query", "description" : "Filter by dialed_digits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roaming_ind]", "in" : "query", "description" : "Filter by roaming_ind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roaming_provider]", "in" : "query", "description" : "Filter by roaming_provider (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_code]", "in" : "query", "description" : "Filter by country_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[duration_time]", "in" : "query", "description" : "Filter by duration_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sequence_num]", "in" : "query", "description" : "Filter by sequence_num (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_type]", "in" : "query", "description" : "Filter by data_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filler]", "in" : "query", "description" : "Filter by filler (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[verizonWirelessInventoryUsageSummary]", "in" : "query", "description" : "Filter by verizonWirelessInventoryUsageSummary (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachmentEntities/{id}" : { "get" : { "description" : "Retrieve a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" }, { "$ref" : "#/components/parameters/AttachmentEntitiesFields" }, { "$ref" : "#/components/parameters/AttachmentEntitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AttachmentEntities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AttachmentEntities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachmentEntities" : { "get" : { "description" : "Retrieve a List of attachmentEntities resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_name]", "in" : "query", "description" : "Filter by attachment_entity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_table]", "in" : "query", "description" : "Filter by entity_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachments]", "in" : "query", "description" : "Filter by attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesFields" }, { "$ref" : "#/components/parameters/AttachmentEntitiesInclude" }, { "$ref" : "#/components/parameters/AttachmentEntitiesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AttachmentEntities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachmentEntities/{id}/application" : { "get" : { "description" : "Retrieve applications related to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" }, { "$ref" : "#/components/parameters/ApplicationsFields" }, { "$ref" : "#/components/parameters/ApplicationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attachmentEntities relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attachmentEntities relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attachmentEntities relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachmentEntities/{id}/attachments" : { "get" : { "description" : "Retrieve attachment related to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[volume_id]", "in" : "query", "description" : "Filter by volume_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[priv]", "in" : "query", "description" : "Filter by priv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filename]", "in" : "query", "description" : "Filter by filename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filetype]", "in" : "query", "description" : "Filter by filetype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filesize]", "in" : "query", "description" : "Filter by filesize (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_id]", "in" : "query", "description" : "Filter by attachment_entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_int]", "in" : "query", "description" : "Filter by pk1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_int]", "in" : "query", "description" : "Filter by pk2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_int]", "in" : "query", "description" : "Filter by pk3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_var]", "in" : "query", "description" : "Filter by pk1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_var]", "in" : "query", "description" : "Filter by pk2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_var]", "in" : "query", "description" : "Filter by pk3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[storageVolume]", "in" : "query", "description" : "Filter by storageVolume (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentEntity]", "in" : "query", "description" : "Filter by attachmentEntity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentFields" }, { "$ref" : "#/components/parameters/AttachmentInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachmentEntities/{id}/relationships/application" : { "get" : { "description" : "Retrieve applications references related to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" }, { "$ref" : "#/components/parameters/ApplicationsFields" }, { "$ref" : "#/components/parameters/ApplicationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attachmentEntities relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attachmentEntities relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attachmentEntities relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachmentEntities/{id}/relationships/attachments" : { "get" : { "description" : "Retrieve attachment references related to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[volume_id]", "in" : "query", "description" : "Filter by volume_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[priv]", "in" : "query", "description" : "Filter by priv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filename]", "in" : "query", "description" : "Filter by filename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filetype]", "in" : "query", "description" : "Filter by filetype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filesize]", "in" : "query", "description" : "Filter by filesize (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_id]", "in" : "query", "description" : "Filter by attachment_entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_int]", "in" : "query", "description" : "Filter by pk1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_int]", "in" : "query", "description" : "Filter by pk2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_int]", "in" : "query", "description" : "Filter by pk3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_var]", "in" : "query", "description" : "Filter by pk1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_var]", "in" : "query", "description" : "Filter by pk2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_var]", "in" : "query", "description" : "Filter by pk3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[storageVolume]", "in" : "query", "description" : "Filter by storageVolume (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentEntity]", "in" : "query", "description" : "Filter by attachmentEntity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentFields" }, { "$ref" : "#/components/parameters/AttachmentInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}" : { "get" : { "description" : "Retrieve a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Damages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Damages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages" : { "get" : { "description" : "Retrieve a List of damages resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_reported_date]", "in" : "query", "description" : "Filter by damage_reported_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_create_date]", "in" : "query", "description" : "Filter by damage_create_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_date_time]", "in" : "query", "description" : "Filter by damage_date_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispatcher_id]", "in" : "query", "description" : "Filter by dispatcher_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_category_id]", "in" : "query", "description" : "Filter by notified_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cdi_id]", "in" : "query", "description" : "Filter by cdi_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_num]", "in" : "query", "description" : "Filter by one_call_request_num (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_by_name]", "in" : "query", "description" : "Filter by notified_by_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_stmt_call_notes]", "in" : "query", "description" : "Filter by caller_stmt_call_notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_number]", "in" : "query", "description" : "Filter by damage_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_by_phone]", "in" : "query", "description" : "Filter by notified_by_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_by_email]", "in" : "query", "description" : "Filter by notified_by_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source]", "in" : "query", "description" : "Filter by source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_by_extension]", "in" : "query", "description" : "Filter by notified_by_extension (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_company]", "in" : "query", "description" : "Filter by caller_company (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paged_date_time]", "in" : "query", "description" : "Filter by paged_date_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[confirmaton_date_time]", "in" : "query", "description" : "Filter by confirmaton_date_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_rep]", "in" : "query", "description" : "Filter by customer_rep (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cdi_confirmation]", "in" : "query", "description" : "Filter by cdi_confirmation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claims]", "in" : "query", "description" : "Filter by claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damageListings]", "in" : "query", "description" : "Filter by damageListings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersions]", "in" : "query", "description" : "Filter by investigationVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damagePhotos]", "in" : "query", "description" : "Filter by damagePhotos (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" }, { "$ref" : "#/components/parameters/DamagesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Damages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/claims" : { "get" : { "description" : "Retrieve claims related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/legalDamages" : { "get" : { "description" : "Retrieve legalDamages related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalDamagesFields" }, { "$ref" : "#/components/parameters/LegalDamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalDamagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/claimDetails" : { "get" : { "description" : "Retrieve claimDetails related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_variance_reason_id]", "in" : "query", "description" : "Filter by estimate_variance_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_accrual_balance]", "in" : "query", "description" : "Filter by retain_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_version_number]", "in" : "query", "description" : "Filter by estimate_version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_balance]", "in" : "query", "description" : "Filter by estimate_accrued_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_amount]", "in" : "query", "description" : "Filter by estimate_accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/district" : { "get" : { "description" : "Retrieve districts related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/state" : { "get" : { "description" : "Retrieve states related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/damageListings" : { "get" : { "description" : "Retrieve damageListings related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_notification_id]", "in" : "query", "description" : "Filter by dl_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_damage_id]", "in" : "query", "description" : "Filter by dl_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_add1]", "in" : "query", "description" : "Filter by dl_add1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_city]", "in" : "query", "description" : "Filter by dl_city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_abbrev]", "in" : "query", "description" : "Filter by dl_abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_damage_date_time]", "in" : "query", "description" : "Filter by dl_damage_date_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_excavator]", "in" : "query", "description" : "Filter by dl_excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_customer_id]", "in" : "query", "description" : "Filter by dl_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_account_number]", "in" : "query", "description" : "Filter by dl_account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_customer_claim_number]", "in" : "query", "description" : "Filter by dl_customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_duplicate_damage_id]", "in" : "query", "description" : "Filter by dl_duplicate_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[duplicateDamage]", "in" : "query", "description" : "Filter by duplicateDamage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamageListingsFields" }, { "$ref" : "#/components/parameters/DamageListingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageListingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DamageListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/investigationVersions" : { "get" : { "description" : "Retrieve investigationVersions related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approverEmployee]", "in" : "query", "description" : "Filter by approverEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenByEmployee]", "in" : "query", "description" : "Filter by picsTakenByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationVersionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/damagePhotos" : { "get" : { "description" : "Retrieve damagePhotos related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[volume_id]", "in" : "query", "description" : "Filter by volume_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[priv]", "in" : "query", "description" : "Filter by priv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filetype]", "in" : "query", "description" : "Filter by filetype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filename]", "in" : "query", "description" : "Filter by filename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filesize]", "in" : "query", "description" : "Filter by filesize (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_id]", "in" : "query", "description" : "Filter by attachment_entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_int]", "in" : "query", "description" : "Filter by pk1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_name]", "in" : "query", "description" : "Filter by attachment_entity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_table]", "in" : "query", "description" : "Filter by entity_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[protocol]", "in" : "query", "description" : "Filter by protocol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fullUrl]", "in" : "query", "description" : "Filter by fullUrl (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fulltnUrl]", "in" : "query", "description" : "Filter by fulltnUrl (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[number]", "in" : "query", "description" : "Filter by number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentEntities]", "in" : "query", "description" : "Filter by attachmentEntities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[host]", "in" : "query", "description" : "Filter by host (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entityID]", "in" : "query", "description" : "Filter by entityID (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vol]", "in" : "query", "description" : "Filter by vol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamagePhotosFields" }, { "$ref" : "#/components/parameters/DamagePhotosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/claims" : { "get" : { "description" : "Retrieve claims references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/legalDamages" : { "get" : { "description" : "Retrieve legalDamages references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalDamagesFields" }, { "$ref" : "#/components/parameters/LegalDamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/claimDetails" : { "get" : { "description" : "Retrieve claimDetails references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_variance_reason_id]", "in" : "query", "description" : "Filter by estimate_variance_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_accrual_balance]", "in" : "query", "description" : "Filter by retain_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_version_number]", "in" : "query", "description" : "Filter by estimate_version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_balance]", "in" : "query", "description" : "Filter by estimate_accrued_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_amount]", "in" : "query", "description" : "Filter by estimate_accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/district" : { "get" : { "description" : "Retrieve districts references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/state" : { "get" : { "description" : "Retrieve states references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/damageListings" : { "get" : { "description" : "Retrieve damageListings references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_notification_id]", "in" : "query", "description" : "Filter by dl_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_damage_id]", "in" : "query", "description" : "Filter by dl_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_add1]", "in" : "query", "description" : "Filter by dl_add1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_city]", "in" : "query", "description" : "Filter by dl_city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_abbrev]", "in" : "query", "description" : "Filter by dl_abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_damage_date_time]", "in" : "query", "description" : "Filter by dl_damage_date_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_excavator]", "in" : "query", "description" : "Filter by dl_excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_customer_id]", "in" : "query", "description" : "Filter by dl_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_account_number]", "in" : "query", "description" : "Filter by dl_account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_customer_claim_number]", "in" : "query", "description" : "Filter by dl_customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_duplicate_damage_id]", "in" : "query", "description" : "Filter by dl_duplicate_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[duplicateDamage]", "in" : "query", "description" : "Filter by duplicateDamage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamageListingsFields" }, { "$ref" : "#/components/parameters/DamageListingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageListingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DamageListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/investigationVersions" : { "get" : { "description" : "Retrieve investigationVersions references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approverEmployee]", "in" : "query", "description" : "Filter by approverEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenByEmployee]", "in" : "query", "description" : "Filter by picsTakenByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damages/{id}/relationships/damagePhotos" : { "get" : { "description" : "Retrieve damagePhotos references related to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[volume_id]", "in" : "query", "description" : "Filter by volume_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[priv]", "in" : "query", "description" : "Filter by priv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filetype]", "in" : "query", "description" : "Filter by filetype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filename]", "in" : "query", "description" : "Filter by filename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filesize]", "in" : "query", "description" : "Filter by filesize (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_id]", "in" : "query", "description" : "Filter by attachment_entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_int]", "in" : "query", "description" : "Filter by pk1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_name]", "in" : "query", "description" : "Filter by attachment_entity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_table]", "in" : "query", "description" : "Filter by entity_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[protocol]", "in" : "query", "description" : "Filter by protocol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fullUrl]", "in" : "query", "description" : "Filter by fullUrl (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fulltnUrl]", "in" : "query", "description" : "Filter by fulltnUrl (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[number]", "in" : "query", "description" : "Filter by number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentEntities]", "in" : "query", "description" : "Filter by attachmentEntities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[host]", "in" : "query", "description" : "Filter by host (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entityID]", "in" : "query", "description" : "Filter by entityID (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vol]", "in" : "query", "description" : "Filter by vol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamagePhotosFields" }, { "$ref" : "#/components/parameters/DamagePhotosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/customers/{id}" : { "get" : { "description" : "Retrieve a tkpCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/TkpCustomersFields" }, { "$ref" : "#/components/parameters/TkpCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TkpCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpCustomersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TkpCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TkpCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpCustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpCustomersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/customers" : { "get" : { "description" : "Retrieve a List of tkpCustomers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_name]", "in" : "query", "description" : "Filter by account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utilities]", "in" : "query", "description" : "Filter by utilities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TkpCustomersFields" }, { "$ref" : "#/components/parameters/TkpCustomersInclude" }, { "$ref" : "#/components/parameters/TkpCustomersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TkpCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TkpCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpCustomersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/customers/{id}/utilities" : { "get" : { "description" : "Retrieve utilities related to a tkpCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[abbrev]", "in" : "query", "description" : "Filter by abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[office_id]", "in" : "query", "description" : "Filter by office_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[screen_bucket_id]", "in" : "query", "description" : "Filter by screen_bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_area]", "in" : "query", "description" : "Filter by require_area (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[app_key]", "in" : "query", "description" : "Filter by app_key (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[signature_requirement]", "in" : "query", "description" : "Filter by signature_requirement (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type]", "in" : "query", "description" : "Filter by facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_list_id]", "in" : "query", "description" : "Filter by service_list_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[auto_close]", "in" : "query", "description" : "Filter by auto_close (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_billing]", "in" : "query", "description" : "Filter by export_billing (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[has_gis_data]", "in" : "query", "description" : "Filter by has_gis_data (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_certificate]", "in" : "query", "description" : "Filter by require_certificate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_reschedule]", "in" : "query", "description" : "Filter by require_reschedule (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_eta]", "in" : "query", "description" : "Filter by require_eta (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[qc_bucket_id]", "in" : "query", "description" : "Filter by qc_bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[drawing_abbrev]", "in" : "query", "description" : "Filter by drawing_abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[proximity_code]", "in" : "query", "description" : "Filter by proximity_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_manual_time]", "in" : "query", "description" : "Filter by require_manual_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hp_scoring]", "in" : "query", "description" : "Filter by hp_scoring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclude_holdoff]", "in" : "query", "description" : "Filter by exclude_holdoff (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_academy_certificate]", "in" : "query", "description" : "Filter by require_academy_certificate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpCustomer]", "in" : "query", "description" : "Filter by tkpCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/customers/{id}/relationships/utilities" : { "get" : { "description" : "Retrieve utilities references related to a tkpCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[abbrev]", "in" : "query", "description" : "Filter by abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[office_id]", "in" : "query", "description" : "Filter by office_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[screen_bucket_id]", "in" : "query", "description" : "Filter by screen_bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_area]", "in" : "query", "description" : "Filter by require_area (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[app_key]", "in" : "query", "description" : "Filter by app_key (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[signature_requirement]", "in" : "query", "description" : "Filter by signature_requirement (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type]", "in" : "query", "description" : "Filter by facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_list_id]", "in" : "query", "description" : "Filter by service_list_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[auto_close]", "in" : "query", "description" : "Filter by auto_close (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_billing]", "in" : "query", "description" : "Filter by export_billing (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[has_gis_data]", "in" : "query", "description" : "Filter by has_gis_data (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_certificate]", "in" : "query", "description" : "Filter by require_certificate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_reschedule]", "in" : "query", "description" : "Filter by require_reschedule (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_eta]", "in" : "query", "description" : "Filter by require_eta (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[qc_bucket_id]", "in" : "query", "description" : "Filter by qc_bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[drawing_abbrev]", "in" : "query", "description" : "Filter by drawing_abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[proximity_code]", "in" : "query", "description" : "Filter by proximity_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_manual_time]", "in" : "query", "description" : "Filter by require_manual_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hp_scoring]", "in" : "query", "description" : "Filter by hp_scoring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclude_holdoff]", "in" : "query", "description" : "Filter by exclude_holdoff (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_academy_certificate]", "in" : "query", "description" : "Filter by require_academy_certificate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpCustomer]", "in" : "query", "description" : "Filter by tkpCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/tokens/{id}" : { "get" : { "description" : "Retrieve a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" }, { "$ref" : "#/components/parameters/TokensFields" }, { "$ref" : "#/components/parameters/TokensInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Tokens", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Tokens", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/tokens" : { "get" : { "description" : "Retrieve a List of tokens resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[token]", "in" : "query", "description" : "Filter by token (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TokensFields" }, { "$ref" : "#/components/parameters/TokensInclude" }, { "$ref" : "#/components/parameters/TokensSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Tokens", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/tokens/{id}/user" : { "get" : { "description" : "Retrieve wsUsers related to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" }, { "$ref" : "#/components/parameters/WsUsersFields" }, { "$ref" : "#/components/parameters/WsUsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourceResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create tokens relationship to a wsUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete tokens relationship to a wsUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update tokens relationship to a wsUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/tokens/{id}/userAccesses" : { "get" : { "description" : "Retrieve wsUserAccesses related to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[token_id]", "in" : "query", "description" : "Filter by token_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[namespace]", "in" : "query", "description" : "Filter by namespace (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[classs]", "in" : "query", "description" : "Filter by classs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[method]", "in" : "query", "description" : "Filter by method (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[token]", "in" : "query", "description" : "Filter by token (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesFields" }, { "$ref" : "#/components/parameters/WsUserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create tokens relationship to a wsUserAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete tokens relationship to a wsUserAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update tokens relationship to a wsUserAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/tokens/{id}/relationships/user" : { "get" : { "description" : "Retrieve wsUsers references related to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" }, { "$ref" : "#/components/parameters/WsUsersFields" }, { "$ref" : "#/components/parameters/WsUsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create tokens relationship to a wsUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete tokens relationship to a wsUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update tokens relationship to a wsUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/tokens/{id}/relationships/userAccesses" : { "get" : { "description" : "Retrieve wsUserAccesses references related to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[token_id]", "in" : "query", "description" : "Filter by token_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[namespace]", "in" : "query", "description" : "Filter by namespace (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[classs]", "in" : "query", "description" : "Filter by classs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[method]", "in" : "query", "description" : "Filter by method (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[token]", "in" : "query", "description" : "Filter by token (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesFields" }, { "$ref" : "#/components/parameters/WsUserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create tokens relationship to a wsUserAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete tokens relationship to a wsUserAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update tokens relationship to a wsUserAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/responseLogs/{id}" : { "get" : { "description" : "Retrieve a responseLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ResponseLogsPrimaryKey" }, { "$ref" : "#/components/parameters/ResponseLogsFields" }, { "$ref" : "#/components/parameters/ResponseLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ResponseLogsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ResponseLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ResponseLogsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ResponseLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ResponseLogsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ResponseLogsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/responseLogs" : { "get" : { "description" : "Retrieve a List of responseLogs resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_sent]", "in" : "query", "description" : "Filter by when_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whenreplied]", "in" : "query", "description" : "Filter by whenreplied (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reply]", "in" : "query", "description" : "Filter by reply (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[success]", "in" : "query", "description" : "Filter by success (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[codesent]", "in" : "query", "description" : "Filter by codesent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq_number]", "in" : "query", "description" : "Filter by seq_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ResponseLogsFields" }, { "$ref" : "#/components/parameters/ResponseLogsInclude" }, { "$ref" : "#/components/parameters/ResponseLogsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ResponseLogsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ResponseLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ResponseLogsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ResponseLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/responseLogs/{id}/activity" : { "get" : { "description" : "Retrieve activities related to a responseLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ResponseLogsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/responseLogs/{id}/feed" : { "get" : { "description" : "Retrieve feeds related to a responseLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ResponseLogsPrimaryKey" }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/responseLogs/{id}/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase related to a responseLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ResponseLogsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/responseLogs/{id}/relationships/activity" : { "get" : { "description" : "Retrieve activities references related to a responseLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ResponseLogsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/responseLogs/{id}/relationships/feed" : { "get" : { "description" : "Retrieve feeds references related to a responseLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ResponseLogsPrimaryKey" }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/responseLogs/{id}/relationships/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase references related to a responseLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ResponseLogsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/changeLogs/{id}" : { "get" : { "description" : "Retrieve a changeLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ChangeLogsPrimaryKey" }, { "$ref" : "#/components/parameters/ChangeLogsFields" }, { "$ref" : "#/components/parameters/ChangeLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ChangeLogsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ChangeLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ChangeLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ChangeLogsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ChangeLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ChangeLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ChangeLogsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ChangeLogsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ChangeLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/changeLogs" : { "get" : { "description" : "Retrieve a List of changeLogs resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type]", "in" : "query", "description" : "Filter by type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fieldname]", "in" : "query", "description" : "Filter by fieldname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[old_value]", "in" : "query", "description" : "Filter by old_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[new_value]", "in" : "query", "description" : "Filter by new_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ChangeLogsFields" }, { "$ref" : "#/components/parameters/ChangeLogsInclude" }, { "$ref" : "#/components/parameters/ChangeLogsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ChangeLogsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ChangeLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ChangeLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ChangeLogsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ChangeLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ChangeLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/changeLogs/{id}/asset" : { "get" : { "description" : "Retrieve assets related to a changeLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ChangeLogsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/changeLogs/{id}/relationships/asset" : { "get" : { "description" : "Retrieve assets references related to a changeLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ChangeLogsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}" : { "get" : { "description" : "Retrieve a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Locates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Locates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates" : { "get" : { "description" : "Retrieve a List of locates resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" }, { "$ref" : "#/components/parameters/LocatesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Locates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/bucket" : { "get" : { "description" : "Retrieve buckets related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/transmissionExtra" : { "get" : { "description" : "Retrieve transmissionExtras related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/transmission" : { "get" : { "description" : "Retrieve transmissions related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/latestActivity" : { "get" : { "description" : "Retrieve activities related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/firstClosingActivity" : { "get" : { "description" : "Retrieve activities related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/term" : { "get" : { "description" : "Retrieve terms related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/termUtilityMap" : { "get" : { "description" : "Retrieve termUtilityMaps related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TermUtilityMapsFields" }, { "$ref" : "#/components/parameters/TermUtilityMapsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermUtilityMapsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/activities" : { "get" : { "description" : "Retrieve activities related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/utility" : { "get" : { "description" : "Retrieve utilities related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/projectTicket" : { "get" : { "description" : "Retrieve projectTickets related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/bucket" : { "get" : { "description" : "Retrieve buckets references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/transmissionExtra" : { "get" : { "description" : "Retrieve transmissionExtras references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/transmission" : { "get" : { "description" : "Retrieve transmissions references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/latestActivity" : { "get" : { "description" : "Retrieve activities references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/firstClosingActivity" : { "get" : { "description" : "Retrieve activities references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/term" : { "get" : { "description" : "Retrieve terms references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/termUtilityMap" : { "get" : { "description" : "Retrieve termUtilityMaps references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/TermUtilityMapsFields" }, { "$ref" : "#/components/parameters/TermUtilityMapsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/activities" : { "get" : { "description" : "Retrieve activities references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/utility" : { "get" : { "description" : "Retrieve utilities references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locates/{id}/relationships/projectTicket" : { "get" : { "description" : "Retrieve projectTickets references related to a locates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatesPrimaryKey" }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetStatuses/{id}" : { "get" : { "description" : "Retrieve a assetStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetStatusesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetStatusesFields" }, { "$ref" : "#/components/parameters/AssetStatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetStatuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetStatusesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetStatuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetStatusesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetStatuses" : { "get" : { "description" : "Retrieve a List of assetStatuses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetStatusesFields" }, { "$ref" : "#/components/parameters/AssetStatusesInclude" }, { "$ref" : "#/components/parameters/AssetStatusesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetStatuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetStatuses/{id}/assets" : { "get" : { "description" : "Retrieve assets related to a assetStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetStatusesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetStatuses/{id}/relationships/assets" : { "get" : { "description" : "Retrieve assets references related to a assetStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetStatusesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesTypes/{id}" : { "get" : { "description" : "Retrieve a casesTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesTypesPrimaryKey" }, { "$ref" : "#/components/parameters/CasesTypesFields" }, { "$ref" : "#/components/parameters/CasesTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CasesTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CasesTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesTypesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CasesTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CasesTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesTypesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesTypesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CasesTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesTypes" : { "get" : { "description" : "Retrieve a List of casesTypes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_description]", "in" : "query", "description" : "Filter by cases_type_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCases]", "in" : "query", "description" : "Filter by legalCases (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtypes]", "in" : "query", "description" : "Filter by casesSubtypes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CasesTypesFields" }, { "$ref" : "#/components/parameters/CasesTypesInclude" }, { "$ref" : "#/components/parameters/CasesTypesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesTypesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CasesTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CasesTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesTypesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CasesTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesTypes/{id}/legalCases" : { "get" : { "description" : "Retrieve legalCases related to a casesTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_id]", "in" : "query", "description" : "Filter by cases_sub_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_manager_id]", "in" : "query", "description" : "Filter by case_manager_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_adjuster_id]", "in" : "query", "description" : "Filter by insurance_adjuster_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_id]", "in" : "query", "description" : "Filter by legal_party_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sued_by_type_id]", "in" : "query", "description" : "Filter by sued_by_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_site_id]", "in" : "query", "description" : "Filter by law_firm_site_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_name]", "in" : "query", "description" : "Filter by case_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[litigation_status_id]", "in" : "query", "description" : "Filter by litigation_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_served]", "in" : "query", "description" : "Filter by date_served (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_sent_to_attorney]", "in" : "query", "description" : "Filter by date_sent_to_attorney (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[matter_number]", "in" : "query", "description" : "Filter by matter_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[court_case_number]", "in" : "query", "description" : "Filter by court_case_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_agreed_date]", "in" : "query", "description" : "Filter by damage_agreed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_claim]", "in" : "query", "description" : "Filter by insurance_claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_status]", "in" : "query", "description" : "Filter by case_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trial_date]", "in" : "query", "description" : "Filter by trial_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mediation_date]", "in" : "query", "description" : "Filter by mediation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParty]", "in" : "query", "description" : "Filter by legalParty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtype]", "in" : "query", "description" : "Filter by casesSubtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesTypes/{id}/casesSubtypes" : { "get" : { "description" : "Retrieve casesSubtypes related to a casesTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_description]", "in" : "query", "description" : "Filter by cases_sub_type_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCases]", "in" : "query", "description" : "Filter by legalCases (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesFields" }, { "$ref" : "#/components/parameters/CasesSubtypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesSubtypesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesTypes/{id}/relationships/legalCases" : { "get" : { "description" : "Retrieve legalCases references related to a casesTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_id]", "in" : "query", "description" : "Filter by cases_sub_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_manager_id]", "in" : "query", "description" : "Filter by case_manager_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_adjuster_id]", "in" : "query", "description" : "Filter by insurance_adjuster_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_id]", "in" : "query", "description" : "Filter by legal_party_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sued_by_type_id]", "in" : "query", "description" : "Filter by sued_by_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_site_id]", "in" : "query", "description" : "Filter by law_firm_site_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_name]", "in" : "query", "description" : "Filter by case_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[litigation_status_id]", "in" : "query", "description" : "Filter by litigation_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_served]", "in" : "query", "description" : "Filter by date_served (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_sent_to_attorney]", "in" : "query", "description" : "Filter by date_sent_to_attorney (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[matter_number]", "in" : "query", "description" : "Filter by matter_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[court_case_number]", "in" : "query", "description" : "Filter by court_case_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_agreed_date]", "in" : "query", "description" : "Filter by damage_agreed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_claim]", "in" : "query", "description" : "Filter by insurance_claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_status]", "in" : "query", "description" : "Filter by case_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trial_date]", "in" : "query", "description" : "Filter by trial_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mediation_date]", "in" : "query", "description" : "Filter by mediation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParty]", "in" : "query", "description" : "Filter by legalParty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtype]", "in" : "query", "description" : "Filter by casesSubtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesTypes/{id}/relationships/casesSubtypes" : { "get" : { "description" : "Retrieve casesSubtypes references related to a casesTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_description]", "in" : "query", "description" : "Filter by cases_sub_type_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCases]", "in" : "query", "description" : "Filter by legalCases (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesFields" }, { "$ref" : "#/components/parameters/CasesSubtypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/statuses/{id}" : { "get" : { "description" : "Retrieve a statuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesPrimaryKey" }, { "$ref" : "#/components/parameters/StatusesFields" }, { "$ref" : "#/components/parameters/StatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "delete" : { "description" : "Delete a Statuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Statuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/statuses" : { "get" : { "description" : "Retrieve a List of statuses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeMessages]", "in" : "query", "description" : "Filter by employeeMessages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/StatusesFields" }, { "$ref" : "#/components/parameters/StatusesInclude" }, { "$ref" : "#/components/parameters/StatusesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create a Statuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/statuses/{id}/employeeMessages" : { "get" : { "description" : "Retrieve employeeMessages related to a statuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sent_at]", "in" : "query", "description" : "Filter by sent_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_read_at]", "in" : "query", "description" : "Filter by first_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_read_at]", "in" : "query", "description" : "Filter by last_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cleared_at]", "in" : "query", "description" : "Filter by cleared_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledged_at]", "in" : "query", "description" : "Filter by acknowledged_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[channel]", "in" : "query", "description" : "Filter by channel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recipient_email]", "in" : "query", "description" : "Filter by recipient_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_detail]", "in" : "query", "description" : "Filter by delivery_detail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_attempts]", "in" : "query", "description" : "Filter by delivery_attempts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimed_at]", "in" : "query", "description" : "Filter by claimed_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerInfo]", "in" : "query", "description" : "Filter by schedulerInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messageWithCount]", "in" : "query", "description" : "Filter by messageWithCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesFields" }, { "$ref" : "#/components/parameters/EmployeeMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/messaging/1.0/statuses/{id}/relationships/employeeMessages" : { "get" : { "description" : "Retrieve employeeMessages references related to a statuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sent_at]", "in" : "query", "description" : "Filter by sent_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_read_at]", "in" : "query", "description" : "Filter by first_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_read_at]", "in" : "query", "description" : "Filter by last_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cleared_at]", "in" : "query", "description" : "Filter by cleared_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledged_at]", "in" : "query", "description" : "Filter by acknowledged_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[channel]", "in" : "query", "description" : "Filter by channel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recipient_email]", "in" : "query", "description" : "Filter by recipient_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_detail]", "in" : "query", "description" : "Filter by delivery_detail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_attempts]", "in" : "query", "description" : "Filter by delivery_attempts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimed_at]", "in" : "query", "description" : "Filter by claimed_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerInfo]", "in" : "query", "description" : "Filter by schedulerInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messageWithCount]", "in" : "query", "description" : "Filter by messageWithCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesFields" }, { "$ref" : "#/components/parameters/EmployeeMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/ticketpro/1.0/transmissionsText/{id}" : { "get" : { "description" : "Retrieve a transmissionsText resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TransmissionsText", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TransmissionsText", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsTextPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsText" : { "get" : { "description" : "Retrieve a List of transmissionsText resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[raw_image]", "in" : "query", "description" : "Filter by raw_image (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" }, { "$ref" : "#/components/parameters/TransmissionsTextSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TransmissionsText", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsTextPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsTextResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsText/{id}/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail related to a transmissionsText resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsText/{id}/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase related to a transmissionsText resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsText/{id}/locates" : { "get" : { "description" : "Retrieve locates related to a transmissionsText resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsText/{id}/relationships/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail references related to a transmissionsText resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsText/{id}/relationships/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase references related to a transmissionsText resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsText/{id}/relationships/locates" : { "get" : { "description" : "Retrieve locates references related to a transmissionsText resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsTextPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/photoCompliances/{id}" : { "get" : { "description" : "Retrieve a photoCompliances resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PhotoCompliancesPrimaryKey" }, { "$ref" : "#/components/parameters/PhotoCompliancesFields" }, { "$ref" : "#/components/parameters/PhotoCompliancesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PhotoCompliancesResourceResponse" }, "202" : { "$ref" : "#/components/responses/PhotoCompliancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a PhotoCompliances", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PhotoCompliancesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/PhotoCompliancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a PhotoCompliances", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PhotoCompliancesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PhotoCompliancesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PhotoCompliancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/photoCompliances" : { "get" : { "description" : "Retrieve a List of photoCompliances resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purpose]", "in" : "query", "description" : "Filter by purpose (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[distance]", "in" : "query", "description" : "Filter by distance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[perimission]", "in" : "query", "description" : "Filter by perimission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_name]", "in" : "query", "description" : "Filter by customer_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_codes]", "in" : "query", "description" : "Filter by status_codes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model]", "in" : "query", "description" : "Filter by model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[check_visit_boundary]", "in" : "query", "description" : "Filter by check_visit_boundary (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deleted]", "in" : "query", "description" : "Filter by deleted (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_version]", "in" : "query", "description" : "Filter by model_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_facility_type]", "in" : "query", "description" : "Filter by customer_facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PhotoCompliancesFields" }, { "$ref" : "#/components/parameters/PhotoCompliancesInclude" }, { "$ref" : "#/components/parameters/PhotoCompliancesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PhotoCompliancesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PhotoCompliancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a PhotoCompliances", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PhotoCompliancesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PhotoCompliancesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PhotoCompliancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleAccesses/{id}" : { "get" : { "description" : "Retrieve a roleAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/RoleAccessesFields" }, { "$ref" : "#/components/parameters/RoleAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleAccessesResourceResponse" }, "202" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a RoleAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a RoleAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleAccessesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleAccesses" : { "get" : { "description" : "Retrieve a List of roleAccesses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[role_id]", "in" : "query", "description" : "Filter by role_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action_id]", "in" : "query", "description" : "Filter by action_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_add]", "in" : "query", "description" : "Filter by p_add (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_delete]", "in" : "query", "description" : "Filter by p_delete (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_edit]", "in" : "query", "description" : "Filter by p_edit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_view]", "in" : "query", "description" : "Filter by p_view (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userRole]", "in" : "query", "description" : "Filter by userRole (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roleAction]", "in" : "query", "description" : "Filter by roleAction (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RoleAccessesFields" }, { "$ref" : "#/components/parameters/RoleAccessesInclude" }, { "$ref" : "#/components/parameters/RoleAccessesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a RoleAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleAccessesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleAccesses/{id}/userRole" : { "get" : { "description" : "Retrieve userRoles related to a roleAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/UserRolesFields" }, { "$ref" : "#/components/parameters/UserRolesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create roleAccesses relationship to a userRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete roleAccesses relationship to a userRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update roleAccesses relationship to a userRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleAccesses/{id}/roleAction" : { "get" : { "description" : "Retrieve roleActions related to a roleAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/RoleActionsFields" }, { "$ref" : "#/components/parameters/RoleActionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create roleAccesses relationship to a roleActions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete roleAccesses relationship to a roleActions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update roleAccesses relationship to a roleActions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleAccesses/{id}/relationships/userRole" : { "get" : { "description" : "Retrieve userRoles references related to a roleAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/UserRolesFields" }, { "$ref" : "#/components/parameters/UserRolesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create roleAccesses relationship to a userRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete roleAccesses relationship to a userRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update roleAccesses relationship to a userRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleAccesses/{id}/relationships/roleAction" : { "get" : { "description" : "Retrieve roleActions references related to a roleAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/RoleActionsFields" }, { "$ref" : "#/components/parameters/RoleActionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create roleAccesses relationship to a roleActions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete roleAccesses relationship to a roleActions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update roleAccesses relationship to a roleActions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}" : { "get" : { "description" : "Retrieve a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a FinancialPeriods", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a FinancialPeriods", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FinancialPeriodsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods" : { "get" : { "description" : "Retrieve a List of financialPeriods resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_name]", "in" : "query", "description" : "Filter by period_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[year]", "in" : "query", "description" : "Filter by year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_for_estimates]", "in" : "query", "description" : "Filter by closed_for_estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrualSummaries]", "in" : "query", "description" : "Filter by accrualSummaries (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accruals]", "in" : "query", "description" : "Filter by accruals (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claims]", "in" : "query", "description" : "Filter by claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" }, { "$ref" : "#/components/parameters/FinancialPeriodsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a FinancialPeriods", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FinancialPeriodsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/estimates" : { "get" : { "description" : "Retrieve estimates related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/accrualSummaries" : { "get" : { "description" : "Retrieve accrualSummaries related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[beginning_balance]", "in" : "query", "description" : "Filter by beginning_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ending_balance]", "in" : "query", "description" : "Filter by ending_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_amount]", "in" : "query", "description" : "Filter by period_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[current_flag]", "in" : "query", "description" : "Filter by current_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesFields" }, { "$ref" : "#/components/parameters/AccrualSummariesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualSummariesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/accruals" : { "get" : { "description" : "Retrieve accruals related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source]", "in" : "query", "description" : "Filter by accrual_source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id1]", "in" : "query", "description" : "Filter by accrual_source_id1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id2]", "in" : "query", "description" : "Filter by accrual_source_id2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id3]", "in" : "query", "description" : "Filter by accrual_source_id3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remarks]", "in" : "query", "description" : "Filter by remarks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[variance_amount]", "in" : "query", "description" : "Filter by variance_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_balance]", "in" : "query", "description" : "Filter by retain_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_accrual_balance]", "in" : "query", "description" : "Filter by source_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualsFields" }, { "$ref" : "#/components/parameters/AccrualsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/claims" : { "get" : { "description" : "Retrieve claims related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/legalRisks" : { "get" : { "description" : "Retrieve legalRisks related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_risk_id]", "in" : "query", "description" : "Filter by legal_risk_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawsuit_demand_amount]", "in" : "query", "description" : "Filter by lawsuit_demand_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate]", "in" : "query", "description" : "Filter by estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_flag]", "in" : "query", "description" : "Filter by accrual_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[liability_age]", "in" : "query", "description" : "Filter by liability_age (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_reserve]", "in" : "query", "description" : "Filter by settlement_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_reserve]", "in" : "query", "description" : "Filter by expense_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_accrual_balance]", "in" : "query", "description" : "Filter by expense_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_accrual_balance]", "in" : "query", "description" : "Filter by settlement_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalRisksFields" }, { "$ref" : "#/components/parameters/LegalRisksInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalRisksResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/relationships/estimates" : { "get" : { "description" : "Retrieve estimates references related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/relationships/accrualSummaries" : { "get" : { "description" : "Retrieve accrualSummaries references related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[beginning_balance]", "in" : "query", "description" : "Filter by beginning_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ending_balance]", "in" : "query", "description" : "Filter by ending_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_amount]", "in" : "query", "description" : "Filter by period_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[current_flag]", "in" : "query", "description" : "Filter by current_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesFields" }, { "$ref" : "#/components/parameters/AccrualSummariesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/relationships/accruals" : { "get" : { "description" : "Retrieve accruals references related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source]", "in" : "query", "description" : "Filter by accrual_source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id1]", "in" : "query", "description" : "Filter by accrual_source_id1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id2]", "in" : "query", "description" : "Filter by accrual_source_id2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id3]", "in" : "query", "description" : "Filter by accrual_source_id3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remarks]", "in" : "query", "description" : "Filter by remarks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[variance_amount]", "in" : "query", "description" : "Filter by variance_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_balance]", "in" : "query", "description" : "Filter by retain_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_accrual_balance]", "in" : "query", "description" : "Filter by source_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualsFields" }, { "$ref" : "#/components/parameters/AccrualsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/relationships/claims" : { "get" : { "description" : "Retrieve claims references related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/relationships/legalRisks" : { "get" : { "description" : "Retrieve legalRisks references related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_risk_id]", "in" : "query", "description" : "Filter by legal_risk_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawsuit_demand_amount]", "in" : "query", "description" : "Filter by lawsuit_demand_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate]", "in" : "query", "description" : "Filter by estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_flag]", "in" : "query", "description" : "Filter by accrual_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[liability_age]", "in" : "query", "description" : "Filter by liability_age (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_reserve]", "in" : "query", "description" : "Filter by settlement_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_reserve]", "in" : "query", "description" : "Filter by expense_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_accrual_balance]", "in" : "query", "description" : "Filter by expense_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_accrual_balance]", "in" : "query", "description" : "Filter by settlement_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalRisksFields" }, { "$ref" : "#/components/parameters/LegalRisksInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/financialPeriods/{id}/relationships/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates references related to a financialPeriods resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FinancialPeriodsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleActions/{id}" : { "get" : { "description" : "Retrieve a roleActions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleActionsPrimaryKey" }, { "$ref" : "#/components/parameters/RoleActionsFields" }, { "$ref" : "#/components/parameters/RoleActionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a RoleActions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleActionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a RoleActions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleActionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleActions" : { "get" : { "description" : "Retrieve a List of roleActions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roleAccesses]", "in" : "query", "description" : "Filter by roleAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RoleActionsFields" }, { "$ref" : "#/components/parameters/RoleActionsInclude" }, { "$ref" : "#/components/parameters/RoleActionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleActionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a RoleActions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RoleActionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleActions/{id}/roleAccesses" : { "get" : { "description" : "Retrieve roleAccesses related to a roleActions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleActionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[role_id]", "in" : "query", "description" : "Filter by role_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action_id]", "in" : "query", "description" : "Filter by action_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_add]", "in" : "query", "description" : "Filter by p_add (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_delete]", "in" : "query", "description" : "Filter by p_delete (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_edit]", "in" : "query", "description" : "Filter by p_edit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_view]", "in" : "query", "description" : "Filter by p_view (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userRole]", "in" : "query", "description" : "Filter by userRole (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roleAction]", "in" : "query", "description" : "Filter by roleAction (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RoleAccessesFields" }, { "$ref" : "#/components/parameters/RoleAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/roleActions/{id}/relationships/roleAccesses" : { "get" : { "description" : "Retrieve roleAccesses references related to a roleActions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RoleActionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[role_id]", "in" : "query", "description" : "Filter by role_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action_id]", "in" : "query", "description" : "Filter by action_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_add]", "in" : "query", "description" : "Filter by p_add (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_delete]", "in" : "query", "description" : "Filter by p_delete (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_edit]", "in" : "query", "description" : "Filter by p_edit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_view]", "in" : "query", "description" : "Filter by p_view (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userRole]", "in" : "query", "description" : "Filter by userRole (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roleAction]", "in" : "query", "description" : "Filter by roleAction (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RoleAccessesFields" }, { "$ref" : "#/components/parameters/RoleAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/errorLogs/{id}" : { "get" : { "description" : "Retrieve a cmsErrorLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsErrorLogsPrimaryKey" }, { "$ref" : "#/components/parameters/CmsErrorLogsFields" }, { "$ref" : "#/components/parameters/CmsErrorLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsErrorLogsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CmsErrorLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsErrorLogsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CmsErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CmsErrorLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsErrorLogsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsErrorLogsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/errorLogs" : { "get" : { "description" : "Retrieve a List of cmsErrorLogs resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[severity]", "in" : "query", "description" : "Filter by severity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[error_state]", "in" : "query", "description" : "Filter by error_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[module]", "in" : "query", "description" : "Filter by module (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[line_no]", "in" : "query", "description" : "Filter by line_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[creation_date]", "in" : "query", "description" : "Filter by creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CmsErrorLogsFields" }, { "$ref" : "#/components/parameters/CmsErrorLogsInclude" }, { "$ref" : "#/components/parameters/CmsErrorLogsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsErrorLogsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CmsErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CmsErrorLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsErrorLogsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsErrorLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/cpstorageVolumes/{id}" : { "get" : { "description" : "Retrieve a cpstorageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpstorageVolumesPrimaryKey" }, { "$ref" : "#/components/parameters/CpstorageVolumesFields" }, { "$ref" : "#/components/parameters/CpstorageVolumesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CpstorageVolumesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CpstorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CpstorageVolumes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpstorageVolumesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CpstorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CpstorageVolumes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpstorageVolumesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpstorageVolumesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CpstorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/cpstorageVolumes" : { "get" : { "description" : "Retrieve a List of cpstorageVolumes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[protocol]", "in" : "query", "description" : "Filter by protocol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CpstorageVolumesFields" }, { "$ref" : "#/components/parameters/CpstorageVolumesInclude" }, { "$ref" : "#/components/parameters/CpstorageVolumesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CpstorageVolumesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CpstorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CpstorageVolumes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpstorageVolumesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpstorageVolumesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CpstorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visitLocations/{id}" : { "get" : { "description" : "Retrieve a visitLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitLocationsPrimaryKey" }, { "$ref" : "#/components/parameters/VisitLocationsFields" }, { "$ref" : "#/components/parameters/VisitLocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitLocationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/VisitLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a VisitLocations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitLocationsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/VisitLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a VisitLocations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitLocationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitLocationsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VisitLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visitLocations" : { "get" : { "description" : "Retrieve a List of visitLocations resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[on_site]", "in" : "query", "description" : "Filter by on_site (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[distance]", "in" : "query", "description" : "Filter by distance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source]", "in" : "query", "description" : "Filter by source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VisitLocationsFields" }, { "$ref" : "#/components/parameters/VisitLocationsInclude" }, { "$ref" : "#/components/parameters/VisitLocationsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitLocationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VisitLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a VisitLocations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitLocationsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitLocationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VisitLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visitLocations/{id}/visit" : { "get" : { "description" : "Retrieve visits related to a visitLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitLocationsPrimaryKey" }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourceResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/visitLocations/{id}/relationships/visit" : { "get" : { "description" : "Retrieve visits references related to a visitLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VisitLocationsPrimaryKey" }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsDistricts/{id}" : { "get" : { "description" : "Retrieve a cmsDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/CmsDistrictsFields" }, { "$ref" : "#/components/parameters/CmsDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsDistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CmsDistricts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsDistrictsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CmsDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CmsDistricts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsDistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsDistrictsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsDistricts" : { "get" : { "description" : "Retrieve a List of cmsDistricts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_code]", "in" : "query", "description" : "Filter by district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_name]", "in" : "query", "description" : "Filter by district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CmsDistrictsFields" }, { "$ref" : "#/components/parameters/CmsDistrictsInclude" }, { "$ref" : "#/components/parameters/CmsDistrictsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsDistrictsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CmsDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CmsDistricts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsDistrictsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsDistrictsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalDamages/{id}" : { "get" : { "description" : "Retrieve a legalDamages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalDamagesPrimaryKey" }, { "$ref" : "#/components/parameters/LegalDamagesFields" }, { "$ref" : "#/components/parameters/LegalDamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalDamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a LegalDamages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalDamagesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a LegalDamages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalDamagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalDamagesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalDamages" : { "get" : { "description" : "Retrieve a List of legalDamages resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalDamagesFields" }, { "$ref" : "#/components/parameters/LegalDamagesInclude" }, { "$ref" : "#/components/parameters/LegalDamagesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalDamagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a LegalDamages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalDamagesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalDamagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalDamages/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a legalDamages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalDamagesPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalDamages/{id}/legalCase" : { "get" : { "description" : "Retrieve legalCases related to a legalDamages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalDamagesPrimaryKey" }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalDamages/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a legalDamages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalDamagesPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalDamages/{id}/relationships/legalCase" : { "get" : { "description" : "Retrieve legalCases references related to a legalDamages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalDamagesPrimaryKey" }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/wsUserAccesses/{id}" : { "get" : { "description" : "Retrieve a wsUserAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/WsUserAccessesFields" }, { "$ref" : "#/components/parameters/WsUserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourceResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a WsUserAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a WsUserAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/wsUserAccesses" : { "get" : { "description" : "Retrieve a List of wsUserAccesses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[token_id]", "in" : "query", "description" : "Filter by token_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[namespace]", "in" : "query", "description" : "Filter by namespace (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[classs]", "in" : "query", "description" : "Filter by classs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[method]", "in" : "query", "description" : "Filter by method (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[token]", "in" : "query", "description" : "Filter by token (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesFields" }, { "$ref" : "#/components/parameters/WsUserAccessesInclude" }, { "$ref" : "#/components/parameters/WsUserAccessesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUserAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a WsUserAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WsUserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/wsUserAccesses/{id}/token" : { "get" : { "description" : "Retrieve tokens related to a wsUserAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/TokensFields" }, { "$ref" : "#/components/parameters/TokensInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create wsUserAccesses relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete wsUserAccesses relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update wsUserAccesses relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/wsUserAccesses/{id}/relationships/token" : { "get" : { "description" : "Retrieve tokens references related to a wsUserAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/TokensFields" }, { "$ref" : "#/components/parameters/TokensInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create wsUserAccesses relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete wsUserAccesses relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update wsUserAccesses relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUserAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests/{id}" : { "get" : { "description" : "Retrieve a cmsRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CmsRequests", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CmsRequests", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsRequestsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests" : { "get" : { "description" : "Retrieve a List of cmsRequests resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userid]", "in" : "query", "description" : "Filter by userid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[username]", "in" : "query", "description" : "Filter by username (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[session_id]", "in" : "query", "description" : "Filter by session_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_time]", "in" : "query", "description" : "Filter by start_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_time]", "in" : "query", "description" : "Filter by end_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_name]", "in" : "query", "description" : "Filter by request_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_type]", "in" : "query", "description" : "Filter by request_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_status]", "in" : "query", "description" : "Filter by completed_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param1]", "in" : "query", "description" : "Filter by param1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param2]", "in" : "query", "description" : "Filter by param2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param3]", "in" : "query", "description" : "Filter by param3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param4]", "in" : "query", "description" : "Filter by param4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param5]", "in" : "query", "description" : "Filter by param5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param6]", "in" : "query", "description" : "Filter by param6 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param7]", "in" : "query", "description" : "Filter by param7 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param8]", "in" : "query", "description" : "Filter by param8 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param9]", "in" : "query", "description" : "Filter by param9 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param10]", "in" : "query", "description" : "Filter by param10 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrualSummaries]", "in" : "query", "description" : "Filter by accrualSummaries (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accruals]", "in" : "query", "description" : "Filter by accruals (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" }, { "$ref" : "#/components/parameters/CmsRequestsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CmsRequests", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsRequestsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsRequestsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests/{id}/accrualSummaries" : { "get" : { "description" : "Retrieve accrualSummaries related to a cmsRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[beginning_balance]", "in" : "query", "description" : "Filter by beginning_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ending_balance]", "in" : "query", "description" : "Filter by ending_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_amount]", "in" : "query", "description" : "Filter by period_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[current_flag]", "in" : "query", "description" : "Filter by current_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesFields" }, { "$ref" : "#/components/parameters/AccrualSummariesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualSummariesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests/{id}/accruals" : { "get" : { "description" : "Retrieve accruals related to a cmsRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source]", "in" : "query", "description" : "Filter by accrual_source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id1]", "in" : "query", "description" : "Filter by accrual_source_id1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id2]", "in" : "query", "description" : "Filter by accrual_source_id2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id3]", "in" : "query", "description" : "Filter by accrual_source_id3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remarks]", "in" : "query", "description" : "Filter by remarks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[variance_amount]", "in" : "query", "description" : "Filter by variance_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_balance]", "in" : "query", "description" : "Filter by retain_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_accrual_balance]", "in" : "query", "description" : "Filter by source_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualsFields" }, { "$ref" : "#/components/parameters/AccrualsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests/{id}/legalRisks" : { "get" : { "description" : "Retrieve legalRisks related to a cmsRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_risk_id]", "in" : "query", "description" : "Filter by legal_risk_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawsuit_demand_amount]", "in" : "query", "description" : "Filter by lawsuit_demand_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate]", "in" : "query", "description" : "Filter by estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_flag]", "in" : "query", "description" : "Filter by accrual_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[liability_age]", "in" : "query", "description" : "Filter by liability_age (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_reserve]", "in" : "query", "description" : "Filter by settlement_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_reserve]", "in" : "query", "description" : "Filter by expense_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_accrual_balance]", "in" : "query", "description" : "Filter by expense_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_accrual_balance]", "in" : "query", "description" : "Filter by settlement_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalRisksFields" }, { "$ref" : "#/components/parameters/LegalRisksInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalRisksResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests/{id}/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates related to a cmsRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests/{id}/relationships/accrualSummaries" : { "get" : { "description" : "Retrieve accrualSummaries references related to a cmsRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[beginning_balance]", "in" : "query", "description" : "Filter by beginning_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ending_balance]", "in" : "query", "description" : "Filter by ending_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_amount]", "in" : "query", "description" : "Filter by period_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[current_flag]", "in" : "query", "description" : "Filter by current_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesFields" }, { "$ref" : "#/components/parameters/AccrualSummariesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests/{id}/relationships/accruals" : { "get" : { "description" : "Retrieve accruals references related to a cmsRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source]", "in" : "query", "description" : "Filter by accrual_source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id1]", "in" : "query", "description" : "Filter by accrual_source_id1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id2]", "in" : "query", "description" : "Filter by accrual_source_id2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id3]", "in" : "query", "description" : "Filter by accrual_source_id3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remarks]", "in" : "query", "description" : "Filter by remarks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[variance_amount]", "in" : "query", "description" : "Filter by variance_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_balance]", "in" : "query", "description" : "Filter by retain_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_accrual_balance]", "in" : "query", "description" : "Filter by source_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualsFields" }, { "$ref" : "#/components/parameters/AccrualsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests/{id}/relationships/legalRisks" : { "get" : { "description" : "Retrieve legalRisks references related to a cmsRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_risk_id]", "in" : "query", "description" : "Filter by legal_risk_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawsuit_demand_amount]", "in" : "query", "description" : "Filter by lawsuit_demand_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate]", "in" : "query", "description" : "Filter by estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_flag]", "in" : "query", "description" : "Filter by accrual_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[liability_age]", "in" : "query", "description" : "Filter by liability_age (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_reserve]", "in" : "query", "description" : "Filter by settlement_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_reserve]", "in" : "query", "description" : "Filter by expense_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_accrual_balance]", "in" : "query", "description" : "Filter by expense_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_accrual_balance]", "in" : "query", "description" : "Filter by settlement_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalRisksFields" }, { "$ref" : "#/components/parameters/LegalRisksInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/requests/{id}/relationships/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates references related to a cmsRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}" : { "get" : { "description" : "Retrieve a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetAssignments", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetAssignments", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments" : { "get" : { "description" : "Retrieve a List of assetAssignments resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" }, { "$ref" : "#/components/parameters/AssetAssignmentsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetAssignments", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/employeesActiveNoAsset" : { "get" : { "description" : "Retrieve employeesActiveNoAssets related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/employeesActiveMultipleItAssets" : { "get" : { "description" : "Retrieve employeesActiveMultipleItAssets related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/assignedByEmployee" : { "get" : { "description" : "Retrieve employees related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/employeeOnLoan" : { "get" : { "description" : "Retrieve employeesOnLoan related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAssignments relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAssignments relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAssignments relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/asset" : { "get" : { "description" : "Retrieve assets related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAssignments relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAssignments relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAssignments relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/relationships/employeesActiveNoAsset" : { "get" : { "description" : "Retrieve employeesActiveNoAssets references related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/relationships/employeesActiveMultipleItAssets" : { "get" : { "description" : "Retrieve employeesActiveMultipleItAssets references related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/relationships/assignedByEmployee" : { "get" : { "description" : "Retrieve employees references related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAssignments relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/relationships/employeeOnLoan" : { "get" : { "description" : "Retrieve employeesOnLoan references related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAssignments relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAssignments relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAssignments relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAssignments/{id}/relationships/asset" : { "get" : { "description" : "Retrieve assets references related to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAssignments relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAssignments relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAssignments relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalParties/{id}" : { "get" : { "description" : "Retrieve a legalParties resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalPartiesPrimaryKey" }, { "$ref" : "#/components/parameters/LegalPartiesFields" }, { "$ref" : "#/components/parameters/LegalPartiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalPartiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a LegalParties", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalPartiesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a LegalParties", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalPartiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalPartiesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalParties" : { "get" : { "description" : "Retrieve a List of legalParties resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_type_id]", "in" : "query", "description" : "Filter by legal_party_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_name]", "in" : "query", "description" : "Filter by first_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_name]", "in" : "query", "description" : "Filter by last_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[middle_name]", "in" : "query", "description" : "Filter by middle_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[preferred_name]", "in" : "query", "description" : "Filter by preferred_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCases]", "in" : "query", "description" : "Filter by legalCases (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalPartiesFields" }, { "$ref" : "#/components/parameters/LegalPartiesInclude" }, { "$ref" : "#/components/parameters/LegalPartiesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalPartiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a LegalParties", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalPartiesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalPartiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalParties/{id}/legalCases" : { "get" : { "description" : "Retrieve legalCases related to a legalParties resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalPartiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_id]", "in" : "query", "description" : "Filter by cases_sub_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_manager_id]", "in" : "query", "description" : "Filter by case_manager_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_adjuster_id]", "in" : "query", "description" : "Filter by insurance_adjuster_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_id]", "in" : "query", "description" : "Filter by legal_party_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sued_by_type_id]", "in" : "query", "description" : "Filter by sued_by_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_site_id]", "in" : "query", "description" : "Filter by law_firm_site_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_name]", "in" : "query", "description" : "Filter by case_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[litigation_status_id]", "in" : "query", "description" : "Filter by litigation_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_served]", "in" : "query", "description" : "Filter by date_served (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_sent_to_attorney]", "in" : "query", "description" : "Filter by date_sent_to_attorney (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[matter_number]", "in" : "query", "description" : "Filter by matter_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[court_case_number]", "in" : "query", "description" : "Filter by court_case_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_agreed_date]", "in" : "query", "description" : "Filter by damage_agreed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_claim]", "in" : "query", "description" : "Filter by insurance_claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_status]", "in" : "query", "description" : "Filter by case_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trial_date]", "in" : "query", "description" : "Filter by trial_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mediation_date]", "in" : "query", "description" : "Filter by mediation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParty]", "in" : "query", "description" : "Filter by legalParty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtype]", "in" : "query", "description" : "Filter by casesSubtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalParties/{id}/lawFirm" : { "get" : { "description" : "Retrieve lawFirms related to a legalParties resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalPartiesPrimaryKey" }, { "$ref" : "#/components/parameters/LawFirmsFields" }, { "$ref" : "#/components/parameters/LawFirmsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LawFirmsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LawFirmsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalParties/{id}/relationships/legalCases" : { "get" : { "description" : "Retrieve legalCases references related to a legalParties resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalPartiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_id]", "in" : "query", "description" : "Filter by cases_sub_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_manager_id]", "in" : "query", "description" : "Filter by case_manager_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_adjuster_id]", "in" : "query", "description" : "Filter by insurance_adjuster_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_id]", "in" : "query", "description" : "Filter by legal_party_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sued_by_type_id]", "in" : "query", "description" : "Filter by sued_by_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_site_id]", "in" : "query", "description" : "Filter by law_firm_site_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_name]", "in" : "query", "description" : "Filter by case_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[litigation_status_id]", "in" : "query", "description" : "Filter by litigation_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_served]", "in" : "query", "description" : "Filter by date_served (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_sent_to_attorney]", "in" : "query", "description" : "Filter by date_sent_to_attorney (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[matter_number]", "in" : "query", "description" : "Filter by matter_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[court_case_number]", "in" : "query", "description" : "Filter by court_case_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_agreed_date]", "in" : "query", "description" : "Filter by damage_agreed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_claim]", "in" : "query", "description" : "Filter by insurance_claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_status]", "in" : "query", "description" : "Filter by case_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trial_date]", "in" : "query", "description" : "Filter by trial_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mediation_date]", "in" : "query", "description" : "Filter by mediation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParty]", "in" : "query", "description" : "Filter by legalParty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtype]", "in" : "query", "description" : "Filter by casesSubtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalParties/{id}/relationships/lawFirm" : { "get" : { "description" : "Retrieve lawFirms references related to a legalParties resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalPartiesPrimaryKey" }, { "$ref" : "#/components/parameters/LawFirmsFields" }, { "$ref" : "#/components/parameters/LawFirmsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LawFirmsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LawFirmsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/utilityandFacilities/{id}" : { "get" : { "description" : "Retrieve a utilityandFacilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilityandFacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/UtilityandFacilitiesFields" }, { "$ref" : "#/components/parameters/UtilityandFacilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilityandFacilitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UtilityandFacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UtilityandFacilities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilityandFacilitiesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UtilityandFacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UtilityandFacilities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilityandFacilitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilityandFacilitiesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UtilityandFacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/utilityandFacilities" : { "get" : { "description" : "Retrieve a List of utilityandFacilities resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_name]", "in" : "query", "description" : "Filter by item_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_type]", "in" : "query", "description" : "Filter by item_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_flag]", "in" : "query", "description" : "Filter by active_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UtilityandFacilitiesFields" }, { "$ref" : "#/components/parameters/UtilityandFacilitiesInclude" }, { "$ref" : "#/components/parameters/UtilityandFacilitiesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilityandFacilitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UtilityandFacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UtilityandFacilities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilityandFacilitiesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UtilityandFacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activityPathPoints/{id}" : { "get" : { "description" : "Retrieve a activityPathPoints resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivityPathPointsFields" }, { "$ref" : "#/components/parameters/ActivityPathPointsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivityPathPointsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ActivityPathPoints", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ActivityPathPoints", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivityPathPointsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activityPathPoints" : { "get" : { "description" : "Retrieve a List of activityPathPoints resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[group_index]", "in" : "query", "description" : "Filter by group_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[order_index]", "in" : "query", "description" : "Filter by order_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_captured]", "in" : "query", "description" : "Filter by when_captured (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source]", "in" : "query", "description" : "Filter by source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[survey_id]", "in" : "query", "description" : "Filter by survey_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsFields" }, { "$ref" : "#/components/parameters/ActivityPathPointsInclude" }, { "$ref" : "#/components/parameters/ActivityPathPointsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivityPathPointsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ActivityPathPoints", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivityPathPointsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activityPathPoints/{id}/activity" : { "get" : { "description" : "Retrieve activities related to a activityPathPoints resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activityPathPoints/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a activityPathPoints resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activityPathPoints/{id}/relationships/activity" : { "get" : { "description" : "Retrieve activities references related to a activityPathPoints resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activityPathPoints/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a activityPathPoints resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/deviceTokens/{id}" : { "get" : { "description" : "Retrieve a deviceTokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeviceTokensPrimaryKey" }, { "$ref" : "#/components/parameters/DeviceTokensFields" }, { "$ref" : "#/components/parameters/DeviceTokensInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourceResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a DeviceTokens", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeviceTokensPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DeviceTokens", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeviceTokensPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/deviceTokens" : { "get" : { "description" : "Retrieve a List of deviceTokens resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_token]", "in" : "query", "description" : "Filter by device_token (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DeviceTokensFields" }, { "$ref" : "#/components/parameters/DeviceTokensInclude" }, { "$ref" : "#/components/parameters/DeviceTokensSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a DeviceTokens", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/deviceTokens/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a deviceTokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeviceTokensPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/deviceTokens/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a deviceTokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeviceTokensPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails/{id}" : { "get" : { "description" : "Retrieve a claimDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ClaimDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ClaimDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDetailsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails" : { "get" : { "description" : "Retrieve a List of claimDetails resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_variance_reason_id]", "in" : "query", "description" : "Filter by estimate_variance_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_accrual_balance]", "in" : "query", "description" : "Filter by retain_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_version_number]", "in" : "query", "description" : "Filter by estimate_version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_balance]", "in" : "query", "description" : "Filter by estimate_accrued_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_amount]", "in" : "query", "description" : "Filter by estimate_accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" }, { "$ref" : "#/components/parameters/ClaimDetailsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ClaimDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDetailsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDetailsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails/{id}/claim" : { "get" : { "description" : "Retrieve claims related to a claimDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails/{id}/legalCase" : { "get" : { "description" : "Retrieve legalCases related to a claimDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a claimDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails/{id}/investigationDetail" : { "get" : { "description" : "Retrieve investigationDetails related to a claimDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails/{id}/relationships/claim" : { "get" : { "description" : "Retrieve claims references related to a claimDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails/{id}/relationships/legalCase" : { "get" : { "description" : "Retrieve legalCases references related to a claimDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a claimDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDetails/{id}/relationships/investigationDetail" : { "get" : { "description" : "Retrieve investigationDetails references related to a claimDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccountAccessView/{id}" : { "get" : { "description" : "Retrieve a userAccountAccessView resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountAccessViewPrimaryKey" }, { "$ref" : "#/components/parameters/UserAccountAccessViewFields" }, { "$ref" : "#/components/parameters/UserAccountAccessViewInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccountAccessViewResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserAccountAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserAccountAccessView", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountAccessViewPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserAccountAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserAccountAccessView", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountAccessViewPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountAccessViewPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserAccountAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccountAccessView" : { "get" : { "description" : "Retrieve a List of userAccountAccessView resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_name]", "in" : "query", "description" : "Filter by cp_user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccountAccessViewFields" }, { "$ref" : "#/components/parameters/UserAccountAccessViewInclude" }, { "$ref" : "#/components/parameters/UserAccountAccessViewSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccountAccessViewResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccountAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserAccountAccessView", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountAccessViewPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountAccessViewResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserAccountAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/votes/{id}" : { "get" : { "description" : "Retrieve a votes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VotesPrimaryKey" }, { "$ref" : "#/components/parameters/VotesFields" }, { "$ref" : "#/components/parameters/VotesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VotesResourceResponse" }, "202" : { "$ref" : "#/components/responses/VotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Votes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VotesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/VotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Votes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VotesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VotesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/votes" : { "get" : { "description" : "Retrieve a List of votes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vote_type]", "in" : "query", "description" : "Filter by vote_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea_id]", "in" : "query", "description" : "Filter by idea_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voter_id]", "in" : "query", "description" : "Filter by voter_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea]", "in" : "query", "description" : "Filter by idea (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VotesFields" }, { "$ref" : "#/components/parameters/VotesInclude" }, { "$ref" : "#/components/parameters/VotesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VotesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Votes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VotesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VotesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/votes/{id}/idea" : { "get" : { "description" : "Retrieve ideas related to a votes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VotesPrimaryKey" }, { "$ref" : "#/components/parameters/IdeasFields" }, { "$ref" : "#/components/parameters/IdeasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeasResourceResponse" }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/votes/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a votes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VotesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/votes/{id}/relationships/idea" : { "get" : { "description" : "Retrieve ideas references related to a votes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VotesPrimaryKey" }, { "$ref" : "#/components/parameters/IdeasFields" }, { "$ref" : "#/components/parameters/IdeasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeasResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/votes/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a votes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VotesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userRequests/{id}" : { "get" : { "description" : "Retrieve a userRequests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRequestsPrimaryKey" }, { "$ref" : "#/components/parameters/UserRequestsFields" }, { "$ref" : "#/components/parameters/UserRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRequestsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserRequests", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRequestsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserRequests", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRequestsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRequestsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userRequests" : { "get" : { "description" : "Retrieve a List of userRequests resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[session_id]", "in" : "query", "description" : "Filter by session_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_user]", "in" : "query", "description" : "Filter by request_user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_method]", "in" : "query", "description" : "Filter by request_method (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_url]", "in" : "query", "description" : "Filter by request_url (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_query_string]", "in" : "query", "description" : "Filter by request_query_string (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_x_real_ip]", "in" : "query", "description" : "Filter by request_x_real_ip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_user_agent]", "in" : "query", "description" : "Filter by request_user_agent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_content_type]", "in" : "query", "description" : "Filter by request_content_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_header_crnk_compact]", "in" : "query", "description" : "Filter by request_header_crnk_compact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[browser_name]", "in" : "query", "description" : "Filter by browser_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[major_version]", "in" : "query", "description" : "Filter by major_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_platform]", "in" : "query", "description" : "Filter by user_platform (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_time_ms]", "in" : "query", "description" : "Filter by request_time_ms (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[response_status]", "in" : "query", "description" : "Filter by response_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[response_content_type]", "in" : "query", "description" : "Filter by response_content_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserRequestsFields" }, { "$ref" : "#/components/parameters/UserRequestsInclude" }, { "$ref" : "#/components/parameters/UserRequestsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRequestsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserRequests", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRequestsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRequestsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/contracts/{id}" : { "get" : { "description" : "Retrieve a contracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" }, { "$ref" : "#/components/parameters/ContractsFields" }, { "$ref" : "#/components/parameters/ContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Contracts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Contracts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/contracts" : { "get" : { "description" : "Retrieve a List of contracts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_number]", "in" : "query", "description" : "Filter by customer_contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_contract_number]", "in" : "query", "description" : "Filter by usic_contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_name]", "in" : "query", "description" : "Filter by account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_effective_date]", "in" : "query", "description" : "Filter by contract_effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_expiration_date]", "in" : "query", "description" : "Filter by contract_expiration_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_stage]", "in" : "query", "description" : "Filter by contract_stage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_type]", "in" : "query", "description" : "Filter by contract_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_utility_type]", "in" : "query", "description" : "Filter by primary_utility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type]", "in" : "query", "description" : "Filter by utility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quote]", "in" : "query", "description" : "Filter by quote (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_contract_type]", "in" : "query", "description" : "Filter by usic_contract_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_liability]", "in" : "query", "description" : "Filter by damage_liability (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_contract_number]", "in" : "query", "description" : "Filter by master_contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ContractsFields" }, { "$ref" : "#/components/parameters/ContractsInclude" }, { "$ref" : "#/components/parameters/ContractsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Contracts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/contracts/{id}/customer" : { "get" : { "description" : "Retrieve customers related to a contracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create contracts relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete contracts relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update contracts relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/contracts/{id}/relationships/customer" : { "get" : { "description" : "Retrieve customers references related to a contracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create contracts relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete contracts relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update contracts relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/tickets/closed/{id}" : { "get" : { "description" : "Retrieve a ticketCloseds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketClosedsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketClosedsFields" }, { "$ref" : "#/components/parameters/TicketClosedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketClosedsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TicketCloseds", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketClosedsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TicketCloseds", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketClosedsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketClosedsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/tickets/closed" : { "get" : { "description" : "Retrieve a List of ticketCloseds resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketClosedsFields" }, { "$ref" : "#/components/parameters/TicketClosedsInclude" }, { "$ref" : "#/components/parameters/TicketClosedsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketClosedsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TicketCloseds", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketClosedsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketClosedsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/tickets/closed/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a ticketCloseds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketClosedsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/tickets/closed/{id}/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase related to a ticketCloseds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketClosedsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/tickets/closed/{id}/transmission" : { "get" : { "description" : "Retrieve transmissions related to a ticketCloseds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketClosedsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/tickets/closed/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a ticketCloseds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketClosedsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/tickets/closed/{id}/relationships/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase references related to a ticketCloseds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketClosedsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/tickets/closed/{id}/relationships/transmission" : { "get" : { "description" : "Retrieve transmissions references related to a ticketCloseds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketClosedsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimAllocationTypes/{id}" : { "get" : { "description" : "Retrieve a claimAllocationTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimAllocationTypesPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimAllocationTypesFields" }, { "$ref" : "#/components/parameters/ClaimAllocationTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ClaimAllocationTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimAllocationTypesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ClaimAllocationTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimAllocationTypesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimAllocationTypesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimAllocationTypes" : { "get" : { "description" : "Retrieve a List of claimAllocationTypes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_allocation_name]", "in" : "query", "description" : "Filter by type_allocation_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq]", "in" : "query", "description" : "Filter by seq (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimAllocationTypesFields" }, { "$ref" : "#/components/parameters/ClaimAllocationTypesInclude" }, { "$ref" : "#/components/parameters/ClaimAllocationTypesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ClaimAllocationTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimAllocationTypesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimAllocationTypes/{id}/claimCategory" : { "get" : { "description" : "Retrieve claimCategories related to a claimAllocationTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimAllocationTypesPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimCategoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimAllocationTypes/{id}/relationships/claimCategory" : { "get" : { "description" : "Retrieve claimCategories references related to a claimAllocationTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimAllocationTypesPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsWithNotifications/{id}" : { "get" : { "description" : "Retrieve a attachmentsWithNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsFields" }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AttachmentsWithNotifications", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AttachmentsWithNotifications", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsWithNotifications" : { "get" : { "description" : "Retrieve a List of attachmentsWithNotifications resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[attachment_type]", "in" : "query", "description" : "Filter by attachment_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_id]", "in" : "query", "description" : "Filter by attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_kind]", "in" : "query", "description" : "Filter by entity_kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_id]", "in" : "query", "description" : "Filter by entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attached_by]", "in" : "query", "description" : "Filter by attached_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_attached]", "in" : "query", "description" : "Filter by when_attached (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_uploaded]", "in" : "query", "description" : "Filter by when_uploaded (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_name]", "in" : "query", "description" : "Filter by file_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_size]", "in" : "query", "description" : "Filter by file_size (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hash]", "in" : "query", "description" : "Filter by hash (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_time]", "in" : "query", "description" : "Filter by created_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_ticket_number]", "in" : "query", "description" : "Filter by original_ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentTag]", "in" : "query", "description" : "Filter by attachmentTag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsFields" }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsInclude" }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AttachmentsWithNotifications", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsWithNotifications/{id}/attachmentTag" : { "get" : { "description" : "Retrieve tkpAttachmentTags related to a attachmentsWithNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsFields" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsWithNotifications/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a attachmentsWithNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsWithNotifications/{id}/relationships/attachmentTag" : { "get" : { "description" : "Retrieve tkpAttachmentTags references related to a attachmentsWithNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsFields" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsWithNotifications/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a attachmentsWithNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesSubtypes/{id}" : { "get" : { "description" : "Retrieve a casesSubtypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesPrimaryKey" }, { "$ref" : "#/components/parameters/CasesSubtypesFields" }, { "$ref" : "#/components/parameters/CasesSubtypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesSubtypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CasesSubtypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CasesSubtypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesSubtypesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesSubtypes" : { "get" : { "description" : "Retrieve a List of casesSubtypes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_description]", "in" : "query", "description" : "Filter by cases_sub_type_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCases]", "in" : "query", "description" : "Filter by legalCases (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesFields" }, { "$ref" : "#/components/parameters/CasesSubtypesInclude" }, { "$ref" : "#/components/parameters/CasesSubtypesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesSubtypesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CasesSubtypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesSubtypesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesSubtypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesSubtypes/{id}/legalCases" : { "get" : { "description" : "Retrieve legalCases related to a casesSubtypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_id]", "in" : "query", "description" : "Filter by cases_sub_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_manager_id]", "in" : "query", "description" : "Filter by case_manager_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_adjuster_id]", "in" : "query", "description" : "Filter by insurance_adjuster_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_id]", "in" : "query", "description" : "Filter by legal_party_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sued_by_type_id]", "in" : "query", "description" : "Filter by sued_by_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_site_id]", "in" : "query", "description" : "Filter by law_firm_site_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_name]", "in" : "query", "description" : "Filter by case_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[litigation_status_id]", "in" : "query", "description" : "Filter by litigation_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_served]", "in" : "query", "description" : "Filter by date_served (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_sent_to_attorney]", "in" : "query", "description" : "Filter by date_sent_to_attorney (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[matter_number]", "in" : "query", "description" : "Filter by matter_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[court_case_number]", "in" : "query", "description" : "Filter by court_case_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_agreed_date]", "in" : "query", "description" : "Filter by damage_agreed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_claim]", "in" : "query", "description" : "Filter by insurance_claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_status]", "in" : "query", "description" : "Filter by case_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trial_date]", "in" : "query", "description" : "Filter by trial_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mediation_date]", "in" : "query", "description" : "Filter by mediation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParty]", "in" : "query", "description" : "Filter by legalParty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtype]", "in" : "query", "description" : "Filter by casesSubtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesSubtypes/{id}/casesType" : { "get" : { "description" : "Retrieve casesTypes related to a casesSubtypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesPrimaryKey" }, { "$ref" : "#/components/parameters/CasesTypesFields" }, { "$ref" : "#/components/parameters/CasesTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CasesTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesSubtypes/{id}/relationships/legalCases" : { "get" : { "description" : "Retrieve legalCases references related to a casesSubtypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_id]", "in" : "query", "description" : "Filter by cases_sub_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_manager_id]", "in" : "query", "description" : "Filter by case_manager_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_adjuster_id]", "in" : "query", "description" : "Filter by insurance_adjuster_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_id]", "in" : "query", "description" : "Filter by legal_party_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sued_by_type_id]", "in" : "query", "description" : "Filter by sued_by_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_site_id]", "in" : "query", "description" : "Filter by law_firm_site_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_name]", "in" : "query", "description" : "Filter by case_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[litigation_status_id]", "in" : "query", "description" : "Filter by litigation_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_served]", "in" : "query", "description" : "Filter by date_served (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_sent_to_attorney]", "in" : "query", "description" : "Filter by date_sent_to_attorney (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[matter_number]", "in" : "query", "description" : "Filter by matter_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[court_case_number]", "in" : "query", "description" : "Filter by court_case_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_agreed_date]", "in" : "query", "description" : "Filter by damage_agreed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_claim]", "in" : "query", "description" : "Filter by insurance_claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_status]", "in" : "query", "description" : "Filter by case_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trial_date]", "in" : "query", "description" : "Filter by trial_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mediation_date]", "in" : "query", "description" : "Filter by mediation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParty]", "in" : "query", "description" : "Filter by legalParty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtype]", "in" : "query", "description" : "Filter by casesSubtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/casesSubtypes/{id}/relationships/casesType" : { "get" : { "description" : "Retrieve casesTypes references related to a casesSubtypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CasesSubtypesPrimaryKey" }, { "$ref" : "#/components/parameters/CasesTypesFields" }, { "$ref" : "#/components/parameters/CasesTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CasesTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccountActivities/{id}" : { "get" : { "description" : "Retrieve a customerAccountActivities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesFields" }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CustomerAccountActivities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CustomerAccountActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CustomerAccountActivities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerAccountActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccountActivities" : { "get" : { "description" : "Retrieve a List of customerAccountActivities resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_name]", "in" : "query", "description" : "Filter by account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[num_users]", "in" : "query", "description" : "Filter by num_users (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_tickets]", "in" : "query", "description" : "Filter by show_tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_damages]", "in" : "query", "description" : "Filter by show_damages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_managed_services]", "in" : "query", "description" : "Filter by show_managed_services (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_logged_on]", "in" : "query", "description" : "Filter by last_logged_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[days]", "in" : "query", "description" : "Filter by days (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesFields" }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesInclude" }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountActivitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CustomerAccountActivities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerAccountActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccountActivities/{id}/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts related to a customerAccountActivities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccountActivities/{id}/relationships/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts references related to a customerAccountActivities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accruals/{id}" : { "get" : { "description" : "Retrieve a accruals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualsPrimaryKey" }, { "$ref" : "#/components/parameters/AccrualsFields" }, { "$ref" : "#/components/parameters/AccrualsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Accruals", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Accruals", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accruals" : { "get" : { "description" : "Retrieve a List of accruals resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source]", "in" : "query", "description" : "Filter by accrual_source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id1]", "in" : "query", "description" : "Filter by accrual_source_id1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id2]", "in" : "query", "description" : "Filter by accrual_source_id2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_source_id3]", "in" : "query", "description" : "Filter by accrual_source_id3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remarks]", "in" : "query", "description" : "Filter by remarks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[variance_amount]", "in" : "query", "description" : "Filter by variance_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_balance]", "in" : "query", "description" : "Filter by retain_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_accrual_balance]", "in" : "query", "description" : "Filter by source_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualsFields" }, { "$ref" : "#/components/parameters/AccrualsInclude" }, { "$ref" : "#/components/parameters/AccrualsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Accruals", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AccrualsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accruals/{id}/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests related to a accruals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualsPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accruals/{id}/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods related to a accruals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualsPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accruals/{id}/district" : { "get" : { "description" : "Retrieve districts related to a accruals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accruals/{id}/relationships/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests references related to a accruals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualsPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accruals/{id}/relationships/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods references related to a accruals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualsPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accruals/{id}/relationships/district" : { "get" : { "description" : "Retrieve districts references related to a accruals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/logos/{id}" : { "get" : { "description" : "Retrieve a logos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LogosPrimaryKey" }, { "$ref" : "#/components/parameters/LogosFields" }, { "$ref" : "#/components/parameters/LogosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LogosResourceResponse" }, "202" : { "$ref" : "#/components/responses/LogosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Logos", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LogosPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LogosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Logos", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LogosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LogosPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LogosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/logos" : { "get" : { "description" : "Retrieve a List of logos resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[label]", "in" : "query", "description" : "Filter by label (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[company_image]", "in" : "query", "description" : "Filter by company_image (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LogosFields" }, { "$ref" : "#/components/parameters/LogosInclude" }, { "$ref" : "#/components/parameters/LogosSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LogosResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LogosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Logos", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LogosPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LogosResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LogosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}" : { "get" : { "description" : "Retrieve a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Estimates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Estimates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EstimatesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates" : { "get" : { "description" : "Retrieve a List of estimates resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" }, { "$ref" : "#/components/parameters/EstimatesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Estimates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EstimatesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EstimatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/cmsInvestigationDetail" : { "get" : { "description" : "Retrieve cmsInvestigationDetails related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/district" : { "get" : { "description" : "Retrieve districts related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/quickCValue" : { "get" : { "description" : "Retrieve quickCodeValue related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/relationships/cmsInvestigationDetail" : { "get" : { "description" : "Retrieve cmsInvestigationDetails references related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/relationships/district" : { "get" : { "description" : "Retrieve districts references related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/relationships/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods references related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/relationships/quickCValue" : { "get" : { "description" : "Retrieve quickCodeValue references related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/estimates/{id}/relationships/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests references related to a estimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageCustomers/{id}" : { "get" : { "description" : "Retrieve a damageCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/DamageCustomersFields" }, { "$ref" : "#/components/parameters/DamageCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamageCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a DamageCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageCustomersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DamageCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DamageCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageCustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageCustomersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamageCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageCustomers" : { "get" : { "description" : "Retrieve a List of damageCustomers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamageCustomersFields" }, { "$ref" : "#/components/parameters/DamageCustomersInclude" }, { "$ref" : "#/components/parameters/DamageCustomersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DamageCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a DamageCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageCustomersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamageCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageCustomers/{id}/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers related to a damageCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageCustomers/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a damageCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageCustomers/{id}/relationships/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers references related to a damageCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageCustomers/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a damageCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities/{id}" : { "get" : { "description" : "Retrieve a facilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/FacilitiesFields" }, { "$ref" : "#/components/parameters/FacilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FacilitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/FacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Facilities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/FacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Facilities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FacilitiesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/FacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities" : { "get" : { "description" : "Retrieve a List of facilities resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fd_damage_id]", "in" : "query", "description" : "Filter by fd_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fd_investigation_id]", "in" : "query", "description" : "Filter by fd_investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fd_customer_name]", "in" : "query", "description" : "Filter by fd_customer_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[flatRateCustomers]", "in" : "query", "description" : "Filter by flatRateCustomers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billableCustomers]", "in" : "query", "description" : "Filter by billableCustomers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/FacilitiesFields" }, { "$ref" : "#/components/parameters/FacilitiesInclude" }, { "$ref" : "#/components/parameters/FacilitiesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FacilitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/FacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Facilities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FacilitiesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FacilitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/FacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities/{id}/flatRateCustomers" : { "get" : { "description" : "Retrieve flatRateCustomers related to a facilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_guarantee]", "in" : "query", "description" : "Filter by count_against_quality_guarantee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[auto_approve_claims]", "in" : "query", "description" : "Filter by auto_approve_claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approval_limit]", "in" : "query", "description" : "Filter by approval_limit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersFields" }, { "$ref" : "#/components/parameters/FlatRateCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FlatRateCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities/{id}/billableCustomers" : { "get" : { "description" : "Retrieve billableCustomers related to a facilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_customers_group_id]", "in" : "query", "description" : "Filter by billable_customers_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_id]", "in" : "query", "description" : "Filter by contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_by_category_id]", "in" : "query", "description" : "Filter by notified_by_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[not_billable]", "in" : "query", "description" : "Filter by not_billable (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_photos_required]", "in" : "query", "description" : "Filter by inv_photos_required (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[days_to_send_report]", "in" : "query", "description" : "Filter by days_to_send_report (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by_id]", "in" : "query", "description" : "Filter by last_updated_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastUpdatedBy]", "in" : "query", "description" : "Filter by lastUpdatedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[createdBy]", "in" : "query", "description" : "Filter by createdBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/BillableCustomersFields" }, { "$ref" : "#/components/parameters/BillableCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BillableCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a facilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a facilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities/{id}/relationships/flatRateCustomers" : { "get" : { "description" : "Retrieve flatRateCustomers references related to a facilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_guarantee]", "in" : "query", "description" : "Filter by count_against_quality_guarantee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[auto_approve_claims]", "in" : "query", "description" : "Filter by auto_approve_claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approval_limit]", "in" : "query", "description" : "Filter by approval_limit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersFields" }, { "$ref" : "#/components/parameters/FlatRateCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities/{id}/relationships/billableCustomers" : { "get" : { "description" : "Retrieve billableCustomers references related to a facilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_customers_group_id]", "in" : "query", "description" : "Filter by billable_customers_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_id]", "in" : "query", "description" : "Filter by contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_by_category_id]", "in" : "query", "description" : "Filter by notified_by_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[not_billable]", "in" : "query", "description" : "Filter by not_billable (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_photos_required]", "in" : "query", "description" : "Filter by inv_photos_required (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[days_to_send_report]", "in" : "query", "description" : "Filter by days_to_send_report (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by_id]", "in" : "query", "description" : "Filter by last_updated_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastUpdatedBy]", "in" : "query", "description" : "Filter by lastUpdatedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[createdBy]", "in" : "query", "description" : "Filter by createdBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/BillableCustomersFields" }, { "$ref" : "#/components/parameters/BillableCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a facilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/facilities/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a facilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FacilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/ticketRequestedServices/{id}" : { "get" : { "description" : "Retrieve a ticketRequestedServices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketRequestedServicesPrimaryKey" }, { "$ref" : "#/components/parameters/TicketRequestedServicesFields" }, { "$ref" : "#/components/parameters/TicketRequestedServicesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketRequestedServicesResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketRequestedServicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TicketRequestedServices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketRequestedServicesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TicketRequestedServicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TicketRequestedServices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketRequestedServicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketRequestedServicesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TicketRequestedServicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/ticketRequestedServices" : { "get" : { "description" : "Retrieve a List of ticketRequestedServices resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_priority]", "in" : "query", "description" : "Filter by high_priority (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[requested_service_date]", "in" : "query", "description" : "Filter by requested_service_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by_rule_id]", "in" : "query", "description" : "Filter by assigned_by_rule_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by_user_id]", "in" : "query", "description" : "Filter by assigned_by_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by_external_user]", "in" : "query", "description" : "Filter by assigned_by_external_user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[modified_date]", "in" : "query", "description" : "Filter by modified_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bore_footage]", "in" : "query", "description" : "Filter by bore_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpTicket]", "in" : "query", "description" : "Filter by tkpTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketRequestedServicesFields" }, { "$ref" : "#/components/parameters/TicketRequestedServicesInclude" }, { "$ref" : "#/components/parameters/TicketRequestedServicesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketRequestedServicesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketRequestedServicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TicketRequestedServices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketRequestedServicesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketRequestedServicesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TicketRequestedServicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}" : { "get" : { "description" : "Retrieve a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CmsCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CmsCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsCustomersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers" : { "get" : { "description" : "Retrieve a List of cmsCustomers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_level_customer_id]", "in" : "query", "description" : "Filter by account_level_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_level_customer]", "in" : "query", "description" : "Filter by account_level_customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damageCustomers]", "in" : "query", "description" : "Filter by damageCustomers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimPayees]", "in" : "query", "description" : "Filter by claimPayees (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[flatRateCustomers]", "in" : "query", "description" : "Filter by flatRateCustomers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billableCustomers]", "in" : "query", "description" : "Filter by billableCustomers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" }, { "$ref" : "#/components/parameters/CmsCustomersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CmsCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsCustomersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/damageCustomers" : { "get" : { "description" : "Retrieve damageCustomers related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamageCustomersFields" }, { "$ref" : "#/components/parameters/DamageCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DamageCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/claimPayees" : { "get" : { "description" : "Retrieve claimPayees related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_name]", "in" : "query", "description" : "Filter by first_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_name]", "in" : "query", "description" : "Filter by last_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimPayeesFields" }, { "$ref" : "#/components/parameters/ClaimPayeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimPayeesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimPayeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/flatRateCustomers" : { "get" : { "description" : "Retrieve flatRateCustomers related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_guarantee]", "in" : "query", "description" : "Filter by count_against_quality_guarantee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[auto_approve_claims]", "in" : "query", "description" : "Filter by auto_approve_claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approval_limit]", "in" : "query", "description" : "Filter by approval_limit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersFields" }, { "$ref" : "#/components/parameters/FlatRateCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FlatRateCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/billableCustomers" : { "get" : { "description" : "Retrieve billableCustomers related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_customers_group_id]", "in" : "query", "description" : "Filter by billable_customers_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_id]", "in" : "query", "description" : "Filter by contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_by_category_id]", "in" : "query", "description" : "Filter by notified_by_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[not_billable]", "in" : "query", "description" : "Filter by not_billable (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_photos_required]", "in" : "query", "description" : "Filter by inv_photos_required (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[days_to_send_report]", "in" : "query", "description" : "Filter by days_to_send_report (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by_id]", "in" : "query", "description" : "Filter by last_updated_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastUpdatedBy]", "in" : "query", "description" : "Filter by lastUpdatedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[createdBy]", "in" : "query", "description" : "Filter by createdBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/BillableCustomersFields" }, { "$ref" : "#/components/parameters/BillableCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BillableCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/investigationDetailsVersions" : { "get" : { "description" : "Retrieve investigationDetailsVersions related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersion]", "in" : "query", "description" : "Filter by investigationVersion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completedBy]", "in" : "query", "description" : "Filter by completedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changedBy]", "in" : "query", "description" : "Filter by changedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/relationships/damageCustomers" : { "get" : { "description" : "Retrieve damageCustomers references related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamageCustomersFields" }, { "$ref" : "#/components/parameters/DamageCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageCustomersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DamageCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/relationships/claimPayees" : { "get" : { "description" : "Retrieve claimPayees references related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_name]", "in" : "query", "description" : "Filter by first_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_name]", "in" : "query", "description" : "Filter by last_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimPayeesFields" }, { "$ref" : "#/components/parameters/ClaimPayeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimPayeesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimPayeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/relationships/flatRateCustomers" : { "get" : { "description" : "Retrieve flatRateCustomers references related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_guarantee]", "in" : "query", "description" : "Filter by count_against_quality_guarantee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[auto_approve_claims]", "in" : "query", "description" : "Filter by auto_approve_claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approval_limit]", "in" : "query", "description" : "Filter by approval_limit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersFields" }, { "$ref" : "#/components/parameters/FlatRateCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/relationships/billableCustomers" : { "get" : { "description" : "Retrieve billableCustomers references related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_customers_group_id]", "in" : "query", "description" : "Filter by billable_customers_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_id]", "in" : "query", "description" : "Filter by contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notified_by_category_id]", "in" : "query", "description" : "Filter by notified_by_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[not_billable]", "in" : "query", "description" : "Filter by not_billable (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_photos_required]", "in" : "query", "description" : "Filter by inv_photos_required (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[days_to_send_report]", "in" : "query", "description" : "Filter by days_to_send_report (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by_id]", "in" : "query", "description" : "Filter by last_updated_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastUpdatedBy]", "in" : "query", "description" : "Filter by lastUpdatedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[createdBy]", "in" : "query", "description" : "Filter by createdBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/BillableCustomersFields" }, { "$ref" : "#/components/parameters/BillableCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/BillableCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsCustomers/{id}/relationships/investigationDetailsVersions" : { "get" : { "description" : "Retrieve investigationDetailsVersions references related to a cmsCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersion]", "in" : "query", "description" : "Filter by investigationVersion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completedBy]", "in" : "query", "description" : "Filter by completedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changedBy]", "in" : "query", "description" : "Filter by changedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportsSectionOrders/{id}" : { "get" : { "description" : "Retrieve a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" }, { "$ref" : "#/components/parameters/ReportsSectionOrdersFields" }, { "$ref" : "#/components/parameters/ReportsSectionOrdersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ReportsSectionOrders", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ReportsSectionOrders", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportsSectionOrders" : { "get" : { "description" : "Retrieve a List of reportsSectionOrders resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_group_section_id]", "in" : "query", "description" : "Filter by report_group_section_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_id]", "in" : "query", "description" : "Filter by report_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq]", "in" : "query", "description" : "Filter by seq (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportGroupSection]", "in" : "query", "description" : "Filter by reportGroupSection (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report]", "in" : "query", "description" : "Filter by report (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersFields" }, { "$ref" : "#/components/parameters/ReportsSectionOrdersInclude" }, { "$ref" : "#/components/parameters/ReportsSectionOrdersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ReportsSectionOrders", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportsSectionOrders/{id}/reportGroupSection" : { "get" : { "description" : "Retrieve reportGroupSections related to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" }, { "$ref" : "#/components/parameters/ReportGroupSectionsFields" }, { "$ref" : "#/components/parameters/ReportGroupSectionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportsSectionOrders relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportsSectionOrders relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportsSectionOrders relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportsSectionOrders/{id}/report" : { "get" : { "description" : "Retrieve reports related to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" }, { "$ref" : "#/components/parameters/ReportsFields" }, { "$ref" : "#/components/parameters/ReportsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportsSectionOrders relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportsSectionOrders relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportsSectionOrders relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportsSectionOrders/{id}/relationships/reportGroupSection" : { "get" : { "description" : "Retrieve reportGroupSections references related to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" }, { "$ref" : "#/components/parameters/ReportGroupSectionsFields" }, { "$ref" : "#/components/parameters/ReportGroupSectionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportsSectionOrders relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportsSectionOrders relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportsSectionOrders relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportsSectionOrders/{id}/relationships/report" : { "get" : { "description" : "Retrieve reports references related to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" }, { "$ref" : "#/components/parameters/ReportsFields" }, { "$ref" : "#/components/parameters/ReportsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportsSectionOrders relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportsSectionOrders relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportsSectionOrders relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageDetails/{id}" : { "get" : { "description" : "Retrieve a damageDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/DamageDetailsFields" }, { "$ref" : "#/components/parameters/DamageDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamageDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a DamageDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageDetailsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DamageDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DamageDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageDetailsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageDetailsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamageDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageDetails" : { "get" : { "description" : "Retrieve a List of damageDetails resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[dd_investigation_id]", "in" : "query", "description" : "Filter by dd_investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_notification_id]", "in" : "query", "description" : "Filter by dd_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_district]", "in" : "query", "description" : "Filter by dd_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_address_1]", "in" : "query", "description" : "Filter by dd_address_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_address_2]", "in" : "query", "description" : "Filter by dd_address_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_city]", "in" : "query", "description" : "Filter by dd_city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_state]", "in" : "query", "description" : "Filter by dd_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_zip_code]", "in" : "query", "description" : "Filter by dd_zip_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_orig_request_id]", "in" : "query", "description" : "Filter by dd_orig_request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_damage_date]", "in" : "query", "description" : "Filter by dd_damage_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_date_reported]", "in" : "query", "description" : "Filter by dd_date_reported (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_notified_by]", "in" : "query", "description" : "Filter by dd_notified_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_caller_company]", "in" : "query", "description" : "Filter by dd_caller_company (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_damaging_excavator]", "in" : "query", "description" : "Filter by dd_damaging_excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_cdi_emp_id]", "in" : "query", "description" : "Filter by dd_cdi_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_cdi_confirmation]", "in" : "query", "description" : "Filter by dd_cdi_confirmation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_notes]", "in" : "query", "description" : "Filter by dd_notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_investigation_date_from]", "in" : "query", "description" : "Filter by dd_investigation_date_from (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_investigation_date_to]", "in" : "query", "description" : "Filter by dd_investigation_date_to (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_type_of_excavation]", "in" : "query", "description" : "Filter by dd_type_of_excavation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_orig_locate_request]", "in" : "query", "description" : "Filter by dd_orig_locate_request (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_start_date]", "in" : "query", "description" : "Filter by dd_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_type_of_ticket]", "in" : "query", "description" : "Filter by dd_type_of_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_damage_request]", "in" : "query", "description" : "Filter by dd_damage_request (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_further_investigation_needed]", "in" : "query", "description" : "Filter by dd_further_investigation_needed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_contact_info]", "in" : "query", "description" : "Filter by dd_contact_info (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_call_date]", "in" : "query", "description" : "Filter by dd_call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_damaged_customer]", "in" : "query", "description" : "Filter by dd_damaged_customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dd_pictures_taken_by]", "in" : "query", "description" : "Filter by dd_pictures_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamageDetailsFields" }, { "$ref" : "#/components/parameters/DamageDetailsInclude" }, { "$ref" : "#/components/parameters/DamageDetailsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DamageDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a DamageDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageDetailsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageDetailsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamageDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTrackMaintenances/{id}" : { "get" : { "description" : "Retrieve a assetTrackMaintenances resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesFields" }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTrackMaintenancesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTrackMaintenancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetTrackMaintenances", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetTrackMaintenancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetTrackMaintenances", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetTrackMaintenancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTrackMaintenances" : { "get" : { "description" : "Retrieve a List of assetTrackMaintenances resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type]", "in" : "query", "description" : "Filter by asset_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tag_number]", "in" : "query", "description" : "Filter by tag_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_name]", "in" : "query", "description" : "Filter by location_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_name]", "in" : "query", "description" : "Filter by organization_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[calibration_due_date]", "in" : "query", "description" : "Filter by calibration_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[task]", "in" : "query", "description" : "Filter by task (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_status]", "in" : "query", "description" : "Filter by asset_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesFields" }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesInclude" }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTrackMaintenancesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetTrackMaintenancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetTrackMaintenances", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetTrackMaintenancesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTrackMaintenances/{id}/asset" : { "get" : { "description" : "Retrieve assets related to a assetTrackMaintenances resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTrackMaintenances/{id}/relationships/asset" : { "get" : { "description" : "Retrieve assets references related to a assetTrackMaintenances resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTrackMaintenancesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attProductCatalogItems/{id}" : { "get" : { "description" : "Retrieve a attProductCatalogItems resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttProductCatalogItemsPrimaryKey" }, { "$ref" : "#/components/parameters/AttProductCatalogItemsFields" }, { "$ref" : "#/components/parameters/AttProductCatalogItemsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttProductCatalogItemsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttProductCatalogItemsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AttProductCatalogItems", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttProductCatalogItemsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttProductCatalogItemsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AttProductCatalogItems", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttProductCatalogItemsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttProductCatalogItemsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attProductCatalogItems" : { "get" : { "description" : "Retrieve a List of attProductCatalogItems resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_type]", "in" : "query", "description" : "Filter by item_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unit_price]", "in" : "query", "description" : "Filter by unit_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unit_measurement]", "in" : "query", "description" : "Filter by unit_measurement (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[charge_type]", "in" : "query", "description" : "Filter by charge_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[soc_code]", "in" : "query", "description" : "Filter by soc_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expiration_date]", "in" : "query", "description" : "Filter by expiration_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[long_description]", "in" : "query", "description" : "Filter by long_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[plan_type]", "in" : "query", "description" : "Filter by plan_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[plan_subtype]", "in" : "query", "description" : "Filter by plan_subtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manufacturer]", "in" : "query", "description" : "Filter by manufacturer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[color]", "in" : "query", "description" : "Filter by color (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[capacity]", "in" : "query", "description" : "Filter by capacity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fn5g_capable]", "in" : "query", "description" : "Filter by fn5g_capable (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mutually_exclusive_features]", "in" : "query", "description" : "Filter by mutually_exclusive_features (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[incompatible_services]", "in" : "query", "description" : "Filter by incompatible_services (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[compatible_services]", "in" : "query", "description" : "Filter by compatible_services (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[compatible_rateplans]", "in" : "query", "description" : "Filter by compatible_rateplans (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttProductCatalogItemsFields" }, { "$ref" : "#/components/parameters/AttProductCatalogItemsInclude" }, { "$ref" : "#/components/parameters/AttProductCatalogItemsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttProductCatalogItemsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttProductCatalogItemsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AttProductCatalogItems", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttProductCatalogItemsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/organizations/{id}" : { "get" : { "description" : "Retrieve a organizations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/OrganizationsPrimaryKey" }, { "$ref" : "#/components/parameters/OrganizationsFields" }, { "$ref" : "#/components/parameters/OrganizationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/OrganizationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/OrganizationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Organizations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/OrganizationsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/OrganizationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Organizations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/OrganizationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/OrganizationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/organizations" : { "get" : { "description" : "Retrieve a List of organizations resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/OrganizationsFields" }, { "$ref" : "#/components/parameters/OrganizationsInclude" }, { "$ref" : "#/components/parameters/OrganizationsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/OrganizationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/OrganizationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Organizations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/OrganizationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/tickets/{id}" : { "get" : { "description" : "Retrieve a tkpTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpTicketsFields" }, { "$ref" : "#/components/parameters/TkpTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpTicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TkpTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpTicketsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TkpTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TkpTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpTicketsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpTicketsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/tickets" : { "get" : { "description" : "Retrieve a List of tkpTickets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccountLocateMatches]", "in" : "query", "description" : "Filter by serviceAccountLocateMatches (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TkpTicketsFields" }, { "$ref" : "#/components/parameters/TkpTicketsInclude" }, { "$ref" : "#/components/parameters/TkpTicketsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpTicketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TkpTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TkpTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpTicketsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpTicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/tickets/{id}/serviceAccountLocateMatches" : { "get" : { "description" : "Retrieve serviceAccountLocateMatches related to a tkpTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_customer_id]", "in" : "query", "description" : "Filter by service_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_expire_date]", "in" : "query", "description" : "Filter by service_expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_name]", "in" : "query", "description" : "Filter by service_contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_email]", "in" : "query", "description" : "Filter by service_contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_billing_type]", "in" : "query", "description" : "Filter by service_billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_feed_email]", "in" : "query", "description" : "Filter by service_feed_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_bore_footage]", "in" : "query", "description" : "Filter by service_bore_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpTicket]", "in" : "query", "description" : "Filter by tkpTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesFields" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/tickets/{id}/relationships/serviceAccountLocateMatches" : { "get" : { "description" : "Retrieve serviceAccountLocateMatches references related to a tkpTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_customer_id]", "in" : "query", "description" : "Filter by service_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_expire_date]", "in" : "query", "description" : "Filter by service_expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_name]", "in" : "query", "description" : "Filter by service_contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_email]", "in" : "query", "description" : "Filter by service_contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_billing_type]", "in" : "query", "description" : "Filter by service_billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_feed_email]", "in" : "query", "description" : "Filter by service_feed_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_bore_footage]", "in" : "query", "description" : "Filter by service_bore_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpTicket]", "in" : "query", "description" : "Filter by tkpTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesFields" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds/{id}" : { "get" : { "description" : "Retrieve a feeds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Feeds", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Feeds", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FeedsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds" : { "get" : { "description" : "Retrieve a List of feeds resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feedname]", "in" : "query", "description" : "Filter by feedname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[queue_responses]", "in" : "query", "description" : "Filter by queue_responses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notify_excavators]", "in" : "query", "description" : "Filter by notify_excavators (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[time_zone]", "in" : "query", "description" : "Filter by time_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_state]", "in" : "query", "description" : "Filter by feed_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual]", "in" : "query", "description" : "Filter by manual (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parser_id]", "in" : "query", "description" : "Filter by parser_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parser_on]", "in" : "query", "description" : "Filter by parser_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[low_volume_threshold]", "in" : "query", "description" : "Filter by low_volume_threshold (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[extensions]", "in" : "query", "description" : "Filter by extensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[allow_combine]", "in" : "query", "description" : "Filter by allow_combine (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[respond_trans]", "in" : "query", "description" : "Filter by respond_trans (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[update_due_dates]", "in" : "query", "description" : "Filter by update_due_dates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_after_hours]", "in" : "query", "description" : "Filter by call_after_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_normal_hours]", "in" : "query", "description" : "Filter by call_normal_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inactive]", "in" : "query", "description" : "Filter by inactive (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notify_reschedule]", "in" : "query", "description" : "Filter by notify_reschedule (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[preferred]", "in" : "query", "description" : "Filter by preferred (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sticky_routing]", "in" : "query", "description" : "Filter by sticky_routing (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reopen_on_update]", "in" : "query", "description" : "Filter by reopen_on_update (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[re_call_normal_hours]", "in" : "query", "description" : "Filter by re_call_normal_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[re_call_after_hours]", "in" : "query", "description" : "Filter by re_call_after_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[respect_state_boundaries]", "in" : "query", "description" : "Filter by respect_state_boundaries (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sqlserverized_routing]", "in" : "query", "description" : "Filter by sqlserverized_routing (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[update_callout_policy]", "in" : "query", "description" : "Filter by update_callout_policy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unlocatable]", "in" : "query", "description" : "Filter by unlocatable (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excav_notif_format]", "in" : "query", "description" : "Filter by excav_notif_format (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[respond_attachments]", "in" : "query", "description" : "Filter by respond_attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[respond_assignments]", "in" : "query", "description" : "Filter by respond_assignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[respond_excav_notif]", "in" : "query", "description" : "Filter by respond_excav_notif (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_reschedule]", "in" : "query", "description" : "Filter by excavator_reschedule (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_center]", "in" : "query", "description" : "Filter by one_call_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[do_not_respond]", "in" : "query", "description" : "Filter by do_not_respond (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unique_transmissions]", "in" : "query", "description" : "Filter by unique_transmissions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[re_call_events]", "in" : "query", "description" : "Filter by re_call_events (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notif_pattern_id]", "in" : "query", "description" : "Filter by notif_pattern_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delay_minutes]", "in" : "query", "description" : "Filter by delay_minutes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attach_transmission]", "in" : "query", "description" : "Filter by attach_transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[route_corporate_holidays]", "in" : "query", "description" : "Filter by route_corporate_holidays (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[terms]", "in" : "query", "description" : "Filter by terms (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionsBase]", "in" : "query", "description" : "Filter by transmissionsBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissions]", "in" : "query", "description" : "Filter by transmissions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" }, { "$ref" : "#/components/parameters/FeedsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Feeds", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FeedsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FeedsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds/{id}/terms" : { "get" : { "description" : "Retrieve terms related to a feeds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse]", "in" : "query", "description" : "Filter by parse (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[charge_once]", "in" : "query", "description" : "Filter by charge_once (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[respond_code]", "in" : "query", "description" : "Filter by respond_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[do_not_respond]", "in" : "query", "description" : "Filter by do_not_respond (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[read_from_master_code]", "in" : "query", "description" : "Filter by read_from_master_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[read_from_members]", "in" : "query", "description" : "Filter by read_from_members (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inactive]", "in" : "query", "description" : "Filter by inactive (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[create_audit_item]", "in" : "query", "description" : "Filter by create_audit_item (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[do_not_close]", "in" : "query", "description" : "Filter by do_not_close (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unlocatable_term_id]", "in" : "query", "description" : "Filter by unlocatable_term_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unlocatable_status_id]", "in" : "query", "description" : "Filter by unlocatable_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_text_only]", "in" : "query", "description" : "Filter by add_text_only (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshots]", "in" : "query", "description" : "Filter by locateClosedSnapshots (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshots]", "in" : "query", "description" : "Filter by locateOpenSnapshots (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds/{id}/transmissionsBase" : { "get" : { "description" : "Retrieve transmissionsBase related to a feeds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_type]", "in" : "query", "description" : "Filter by message_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trans_number]", "in" : "query", "description" : "Filter by trans_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[after_hours]", "in" : "query", "description" : "Filter by after_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet]", "in" : "query", "description" : "Filter by meet (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_date]", "in" : "query", "description" : "Filter by meet_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_code]", "in" : "query", "description" : "Filter by meet_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmitted_legal_due_date]", "in" : "query", "description" : "Filter by transmitted_legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_type]", "in" : "query", "description" : "Filter by transmission_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_area_code]", "in" : "query", "description" : "Filter by service_area_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_code]", "in" : "query", "description" : "Filter by master_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_code]", "in" : "query", "description" : "Filter by billing_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[download_time]", "in" : "query", "description" : "Filter by download_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subdivision]", "in" : "query", "description" : "Filter by subdivision (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_dir]", "in" : "query", "description" : "Filter by street_dir (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lead_time]", "in" : "query", "description" : "Filter by lead_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[blasting]", "in" : "query", "description" : "Filter by blasting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickets]", "in" : "query", "description" : "Filter by tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds/{id}/transmissions" : { "get" : { "description" : "Retrieve transmissions related to a feeds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_type]", "in" : "query", "description" : "Filter by message_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trans_number]", "in" : "query", "description" : "Filter by trans_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[after_hours]", "in" : "query", "description" : "Filter by after_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet]", "in" : "query", "description" : "Filter by meet (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_date]", "in" : "query", "description" : "Filter by meet_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_code]", "in" : "query", "description" : "Filter by meet_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmitted_legal_due_date]", "in" : "query", "description" : "Filter by transmitted_legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_type]", "in" : "query", "description" : "Filter by transmission_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_area_code]", "in" : "query", "description" : "Filter by service_area_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_code]", "in" : "query", "description" : "Filter by master_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_code]", "in" : "query", "description" : "Filter by billing_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[download_time]", "in" : "query", "description" : "Filter by download_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subdivision]", "in" : "query", "description" : "Filter by subdivision (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_dir]", "in" : "query", "description" : "Filter by street_dir (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lead_time]", "in" : "query", "description" : "Filter by lead_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[raw_image]", "in" : "query", "description" : "Filter by raw_image (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sourcefilename]", "in" : "query", "description" : "Filter by sourcefilename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_address_1]", "in" : "query", "description" : "Filter by excavator_address_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_city]", "in" : "query", "description" : "Filter by excavator_city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[maplocation]", "in" : "query", "description" : "Filter by maplocation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapbook]", "in" : "query", "description" : "Filter by mapbook (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[blasting]", "in" : "query", "description" : "Filter by blasting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickets]", "in" : "query", "description" : "Filter by tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds/{id}/responseLogs" : { "get" : { "description" : "Retrieve responseLogs related to a feeds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_sent]", "in" : "query", "description" : "Filter by when_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whenreplied]", "in" : "query", "description" : "Filter by whenreplied (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reply]", "in" : "query", "description" : "Filter by reply (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[success]", "in" : "query", "description" : "Filter by success (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[codesent]", "in" : "query", "description" : "Filter by codesent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq_number]", "in" : "query", "description" : "Filter by seq_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ResponseLogsFields" }, { "$ref" : "#/components/parameters/ResponseLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ResponseLogsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds/{id}/relationships/terms" : { "get" : { "description" : "Retrieve terms references related to a feeds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse]", "in" : "query", "description" : "Filter by parse (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[charge_once]", "in" : "query", "description" : "Filter by charge_once (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[respond_code]", "in" : "query", "description" : "Filter by respond_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[do_not_respond]", "in" : "query", "description" : "Filter by do_not_respond (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[read_from_master_code]", "in" : "query", "description" : "Filter by read_from_master_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[read_from_members]", "in" : "query", "description" : "Filter by read_from_members (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inactive]", "in" : "query", "description" : "Filter by inactive (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[create_audit_item]", "in" : "query", "description" : "Filter by create_audit_item (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[do_not_close]", "in" : "query", "description" : "Filter by do_not_close (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unlocatable_term_id]", "in" : "query", "description" : "Filter by unlocatable_term_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unlocatable_status_id]", "in" : "query", "description" : "Filter by unlocatable_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_text_only]", "in" : "query", "description" : "Filter by add_text_only (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshots]", "in" : "query", "description" : "Filter by locateClosedSnapshots (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshots]", "in" : "query", "description" : "Filter by locateOpenSnapshots (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds/{id}/relationships/transmissionsBase" : { "get" : { "description" : "Retrieve transmissionsBase references related to a feeds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_type]", "in" : "query", "description" : "Filter by message_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trans_number]", "in" : "query", "description" : "Filter by trans_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[after_hours]", "in" : "query", "description" : "Filter by after_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet]", "in" : "query", "description" : "Filter by meet (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_date]", "in" : "query", "description" : "Filter by meet_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_code]", "in" : "query", "description" : "Filter by meet_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmitted_legal_due_date]", "in" : "query", "description" : "Filter by transmitted_legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_type]", "in" : "query", "description" : "Filter by transmission_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_area_code]", "in" : "query", "description" : "Filter by service_area_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_code]", "in" : "query", "description" : "Filter by master_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_code]", "in" : "query", "description" : "Filter by billing_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[download_time]", "in" : "query", "description" : "Filter by download_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subdivision]", "in" : "query", "description" : "Filter by subdivision (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_dir]", "in" : "query", "description" : "Filter by street_dir (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lead_time]", "in" : "query", "description" : "Filter by lead_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[blasting]", "in" : "query", "description" : "Filter by blasting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickets]", "in" : "query", "description" : "Filter by tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds/{id}/relationships/transmissions" : { "get" : { "description" : "Retrieve transmissions references related to a feeds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_type]", "in" : "query", "description" : "Filter by message_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trans_number]", "in" : "query", "description" : "Filter by trans_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[after_hours]", "in" : "query", "description" : "Filter by after_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet]", "in" : "query", "description" : "Filter by meet (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_date]", "in" : "query", "description" : "Filter by meet_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_code]", "in" : "query", "description" : "Filter by meet_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmitted_legal_due_date]", "in" : "query", "description" : "Filter by transmitted_legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_type]", "in" : "query", "description" : "Filter by transmission_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_area_code]", "in" : "query", "description" : "Filter by service_area_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_code]", "in" : "query", "description" : "Filter by master_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_code]", "in" : "query", "description" : "Filter by billing_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[download_time]", "in" : "query", "description" : "Filter by download_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subdivision]", "in" : "query", "description" : "Filter by subdivision (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_dir]", "in" : "query", "description" : "Filter by street_dir (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lead_time]", "in" : "query", "description" : "Filter by lead_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[raw_image]", "in" : "query", "description" : "Filter by raw_image (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sourcefilename]", "in" : "query", "description" : "Filter by sourcefilename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_address_1]", "in" : "query", "description" : "Filter by excavator_address_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_city]", "in" : "query", "description" : "Filter by excavator_city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[maplocation]", "in" : "query", "description" : "Filter by maplocation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapbook]", "in" : "query", "description" : "Filter by mapbook (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[blasting]", "in" : "query", "description" : "Filter by blasting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickets]", "in" : "query", "description" : "Filter by tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/feeds/{id}/relationships/responseLogs" : { "get" : { "description" : "Retrieve responseLogs references related to a feeds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FeedsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_sent]", "in" : "query", "description" : "Filter by when_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whenreplied]", "in" : "query", "description" : "Filter by whenreplied (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reply]", "in" : "query", "description" : "Filter by reply (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[success]", "in" : "query", "description" : "Filter by success (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[codesent]", "in" : "query", "description" : "Filter by codesent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq_number]", "in" : "query", "description" : "Filter by seq_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ResponseLogsFields" }, { "$ref" : "#/components/parameters/ResponseLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userStates/{id}" : { "get" : { "description" : "Retrieve a userStates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserStatesPrimaryKey" }, { "$ref" : "#/components/parameters/UserStatesFields" }, { "$ref" : "#/components/parameters/UserStatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserStatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserStates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserStatesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserStates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserStatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserStatesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userStates" : { "get" : { "description" : "Retrieve a List of userStates resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_name]", "in" : "query", "description" : "Filter by cp_user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserStatesFields" }, { "$ref" : "#/components/parameters/UserStatesInclude" }, { "$ref" : "#/components/parameters/UserStatesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserStatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserStates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserStatesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserStatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTransferExceptions/{id}" : { "get" : { "description" : "Retrieve a assetTransferExceptions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTransferExceptionsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetTransferExceptionsFields" }, { "$ref" : "#/components/parameters/AssetTransferExceptionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTransferExceptionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTransferExceptionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetTransferExceptions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTransferExceptionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetTransferExceptionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetTransferExceptions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTransferExceptionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTransferExceptionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetTransferExceptionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTransferExceptions" : { "get" : { "description" : "Retrieve a List of assetTransferExceptions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_name]", "in" : "query", "description" : "Filter by employee_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_title]", "in" : "query", "description" : "Filter by job_title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type]", "in" : "query", "description" : "Filter by asset_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tag_number]", "in" : "query", "description" : "Filter by tag_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transferring_cost_center]", "in" : "query", "description" : "Filter by transferring_cost_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transferring_district_id]", "in" : "query", "description" : "Filter by transferring_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[receiving_cost_center]", "in" : "query", "description" : "Filter by receiving_cost_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[receiving_district_id]", "in" : "query", "description" : "Filter by receiving_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[receiving_supgroup_code]", "in" : "query", "description" : "Filter by receiving_supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[total_days_in_transit]", "in" : "query", "description" : "Filter by total_days_in_transit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_district_id]", "in" : "query", "description" : "Filter by asset_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_supgroup_code]", "in" : "query", "description" : "Filter by asset_supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetTransferExceptionsFields" }, { "$ref" : "#/components/parameters/AssetTransferExceptionsInclude" }, { "$ref" : "#/components/parameters/AssetTransferExceptionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTransferExceptionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetTransferExceptionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetTransferExceptions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTransferExceptionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetTransferExceptionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTransferExceptions/{id}/asset" : { "get" : { "description" : "Retrieve assets related to a assetTransferExceptions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTransferExceptionsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTransferExceptions/{id}/relationships/asset" : { "get" : { "description" : "Retrieve assets references related to a assetTransferExceptions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTransferExceptionsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/countries/{id}" : { "get" : { "description" : "Retrieve a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" }, { "$ref" : "#/components/parameters/CountriesFields" }, { "$ref" : "#/components/parameters/CountriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "delete" : { "description" : "Delete a Countries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Countries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/countries" : { "get" : { "description" : "Retrieve a List of countries resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_code]", "in" : "query", "description" : "Filter by country_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_name]", "in" : "query", "description" : "Filter by country_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locations]", "in" : "query", "description" : "Filter by locations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[states]", "in" : "query", "description" : "Filter by states (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CountriesFields" }, { "$ref" : "#/components/parameters/CountriesInclude" }, { "$ref" : "#/components/parameters/CountriesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create a Countries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/countries/{id}/locations" : { "get" : { "description" : "Retrieve locations related to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_type_id]", "in" : "query", "description" : "Filter by location_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_id]", "in" : "query", "description" : "Filter by country_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districts]", "in" : "query", "description" : "Filter by districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create countries relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete countries relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update countries relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/countries/{id}/states" : { "get" : { "description" : "Retrieve states related to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[abbrev]", "in" : "query", "description" : "Filter by abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locations]", "in" : "query", "description" : "Filter by locations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create countries relationship to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete countries relationship to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update countries relationship to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/countries/{id}/relationships/locations" : { "get" : { "description" : "Retrieve locations references related to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_type_id]", "in" : "query", "description" : "Filter by location_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_id]", "in" : "query", "description" : "Filter by country_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districts]", "in" : "query", "description" : "Filter by districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create countries relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete countries relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update countries relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/countries/{id}/relationships/states" : { "get" : { "description" : "Retrieve states references related to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[abbrev]", "in" : "query", "description" : "Filter by abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locations]", "in" : "query", "description" : "Filter by locations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create countries relationship to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete countries relationship to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update countries relationship to a states resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CountriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/passkeyCredentials/{id}" : { "get" : { "description" : "Retrieve a passkeyCredentials resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" }, { "$ref" : "#/components/parameters/PasskeyCredentialsFields" }, { "$ref" : "#/components/parameters/PasskeyCredentialsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a PasskeyCredentials", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a PasskeyCredentials", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/passkeyCredentials" : { "get" : { "description" : "Retrieve a List of passkeyCredentials resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passkeyuser_id]", "in" : "query", "description" : "Filter by passkeyuser_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[authenticator_type]", "in" : "query", "description" : "Filter by authenticator_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[credential_id]", "in" : "query", "description" : "Filter by credential_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sign_count]", "in" : "query", "description" : "Filter by sign_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attestation_object]", "in" : "query", "description" : "Filter by attestation_object (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_data]", "in" : "query", "description" : "Filter by client_data (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transports]", "in" : "query", "description" : "Filter by transports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passkeyUser]", "in" : "query", "description" : "Filter by passkeyUser (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsFields" }, { "$ref" : "#/components/parameters/PasskeyCredentialsInclude" }, { "$ref" : "#/components/parameters/PasskeyCredentialsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a PasskeyCredentials", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/passkeyCredentials/{id}/passkeyUser" : { "get" : { "description" : "Retrieve passkeyUsers related to a passkeyCredentials resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" }, { "$ref" : "#/components/parameters/PasskeyUsersFields" }, { "$ref" : "#/components/parameters/PasskeyUsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create passkeyCredentials relationship to a passkeyUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete passkeyCredentials relationship to a passkeyUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update passkeyCredentials relationship to a passkeyUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/passkeyCredentials/{id}/relationships/passkeyUser" : { "get" : { "description" : "Retrieve passkeyUsers references related to a passkeyCredentials resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" }, { "$ref" : "#/components/parameters/PasskeyUsersFields" }, { "$ref" : "#/components/parameters/PasskeyUsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create passkeyCredentials relationship to a passkeyUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete passkeyCredentials relationship to a passkeyUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update passkeyCredentials relationship to a passkeyUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachments/{id}" : { "get" : { "description" : "Retrieve a attachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/AttachmentFields" }, { "$ref" : "#/components/parameters/AttachmentInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Attachment", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Attachment", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachments" : { "get" : { "description" : "Retrieve a List of attachment resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[volume_id]", "in" : "query", "description" : "Filter by volume_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[priv]", "in" : "query", "description" : "Filter by priv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filename]", "in" : "query", "description" : "Filter by filename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filetype]", "in" : "query", "description" : "Filter by filetype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filesize]", "in" : "query", "description" : "Filter by filesize (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_id]", "in" : "query", "description" : "Filter by attachment_entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_int]", "in" : "query", "description" : "Filter by pk1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_int]", "in" : "query", "description" : "Filter by pk2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_int]", "in" : "query", "description" : "Filter by pk3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_var]", "in" : "query", "description" : "Filter by pk1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_var]", "in" : "query", "description" : "Filter by pk2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_var]", "in" : "query", "description" : "Filter by pk3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[storageVolume]", "in" : "query", "description" : "Filter by storageVolume (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentEntity]", "in" : "query", "description" : "Filter by attachmentEntity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentFields" }, { "$ref" : "#/components/parameters/AttachmentInclude" }, { "$ref" : "#/components/parameters/AttachmentSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Attachment", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachments/{id}/storageVolume" : { "get" : { "description" : "Retrieve storageVolumes related to a attachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/StorageVolumesFields" }, { "$ref" : "#/components/parameters/StorageVolumesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attachment relationship to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attachment relationship to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attachment relationship to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachments/{id}/attachmentEntity" : { "get" : { "description" : "Retrieve attachmentEntities related to a attachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/AttachmentEntitiesFields" }, { "$ref" : "#/components/parameters/AttachmentEntitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attachment relationship to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attachment relationship to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attachment relationship to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachments/{id}/relationships/storageVolume" : { "get" : { "description" : "Retrieve storageVolumes references related to a attachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/StorageVolumesFields" }, { "$ref" : "#/components/parameters/StorageVolumesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attachment relationship to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attachment relationship to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attachment relationship to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/attachments/{id}/relationships/attachmentEntity" : { "get" : { "description" : "Retrieve attachmentEntities references related to a attachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/AttachmentEntitiesFields" }, { "$ref" : "#/components/parameters/AttachmentEntitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attachment relationship to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attachment relationship to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attachment relationship to a attachmentEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districts/{id}" : { "get" : { "description" : "Retrieve a tkpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpDistrictsFields" }, { "$ref" : "#/components/parameters/TkpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpDistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TkpDistricts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TkpDistricts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpDistrictsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districts" : { "get" : { "description" : "Retrieve a List of tkpDistricts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_code]", "in" : "query", "description" : "Filter by district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[company_id]", "in" : "query", "description" : "Filter by company_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inactive]", "in" : "query", "description" : "Filter by inactive (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbrev]", "in" : "query", "description" : "Filter by district_abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_name]", "in" : "query", "description" : "Filter by district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[time_zone]", "in" : "query", "description" : "Filter by time_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lunch_lower_limit]", "in" : "query", "description" : "Filter by lunch_lower_limit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lunch_upper_limit]", "in" : "query", "description" : "Filter by lunch_upper_limit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[clock_start]", "in" : "query", "description" : "Filter by clock_start (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_hours_id]", "in" : "query", "description" : "Filter by work_hours_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[productivity_goal]", "in" : "query", "description" : "Filter by productivity_goal (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_min_verison]", "in" : "query", "description" : "Filter by client_min_verison (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_pref_version]", "in" : "query", "description" : "Filter by client_pref_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_code]", "in" : "query", "description" : "Filter by work_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[org_region_id]", "in" : "query", "description" : "Filter by org_region_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickets]", "in" : "query", "description" : "Filter by tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usrs]", "in" : "query", "description" : "Filter by usrs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsFields" }, { "$ref" : "#/components/parameters/TkpDistrictsInclude" }, { "$ref" : "#/components/parameters/TkpDistrictsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpDistrictsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TkpDistricts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpDistrictsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpDistrictsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districts/{id}/tickets" : { "get" : { "description" : "Retrieve tickets related to a tkpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticketsInfo]", "in" : "query", "description" : "Filter by ticketsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachments]", "in" : "query", "description" : "Filter by tkpAttachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentsCategorized]", "in" : "query", "description" : "Filter by attachmentsCategorized (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachmentsWithNotifications]", "in" : "query", "description" : "Filter by tkpAttachmentsWithNotifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkedTickets]", "in" : "query", "description" : "Filter by linkedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districts/{id}/visits" : { "get" : { "description" : "Retrieve visits related to a tkpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[arrived]", "in" : "query", "description" : "Filter by arrived (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[departed]", "in" : "query", "description" : "Filter by departed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[synced_up]", "in" : "query", "description" : "Filter by synced_up (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_saved_local]", "in" : "query", "description" : "Filter by when_saved_local (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[photo_ident]", "in" : "query", "description" : "Filter by photo_ident (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[actor_id]", "in" : "query", "description" : "Filter by actor_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[opened]", "in" : "query", "description" : "Filter by opened (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visitLocation]", "in" : "query", "description" : "Filter by visitLocation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districts/{id}/usrs" : { "get" : { "description" : "Retrieve usrs related to a tkpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prin_type]", "in" : "query", "description" : "Filter by prin_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[displayname]", "in" : "query", "description" : "Filter by displayname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_id]", "in" : "query", "description" : "Filter by billing_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loginname]", "in" : "query", "description" : "Filter by loginname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstname]", "in" : "query", "description" : "Filter by firstname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastname]", "in" : "query", "description" : "Filter by lastname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportingnode]", "in" : "query", "description" : "Filter by reportingnode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activeuser]", "in" : "query", "description" : "Filter by activeuser (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_expires]", "in" : "query", "description" : "Filter by password_expires (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_sync_date]", "in" : "query", "description" : "Filter by last_sync_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_number]", "in" : "query", "description" : "Filter by employee_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[timesheet_start_date]", "in" : "query", "description" : "Filter by timesheet_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[timesheet_end_date]", "in" : "query", "description" : "Filter by timesheet_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_project_id]", "in" : "query", "description" : "Filter by default_project_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reports_to_id]", "in" : "query", "description" : "Filter by reports_to_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[login_for_customer_id]", "in" : "query", "description" : "Filter by login_for_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[department_number]", "in" : "query", "description" : "Filter by department_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[storage_id]", "in" : "query", "description" : "Filter by storage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[home_phone]", "in" : "query", "description" : "Filter by home_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_lockout]", "in" : "query", "description" : "Filter by password_lockout (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_crypt]", "in" : "query", "description" : "Filter by password_crypt (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[failed_logins]", "in" : "query", "description" : "Filter by failed_logins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_number]", "in" : "query", "description" : "Filter by district_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_area]", "in" : "query", "description" : "Filter by work_area (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[peoplesoft_id]", "in" : "query", "description" : "Filter by peoplesoft_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor_group_id]", "in" : "query", "description" : "Filter by supervisor_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_district_id]", "in" : "query", "description" : "Filter by effective_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_supervisor_group_id]", "in" : "query", "description" : "Filter by effective_supervisor_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[truck_number]", "in" : "query", "description" : "Filter by truck_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[at_risk]", "in" : "query", "description" : "Filter by at_risk (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type]", "in" : "query", "description" : "Filter by type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_status]", "in" : "query", "description" : "Filter by user_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[certified]", "in" : "query", "description" : "Filter by certified (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[callout_format]", "in" : "query", "description" : "Filter by callout_format (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_six_ssn]", "in" : "query", "description" : "Filter by last_six_ssn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[org_super_region_id]", "in" : "query", "description" : "Filter by org_super_region_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[org_region_id]", "in" : "query", "description" : "Filter by org_region_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[communication_preference]", "in" : "query", "description" : "Filter by communication_preference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr_manager]", "in" : "query", "description" : "Filter by hr_manager (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[continous_service_date]", "in" : "query", "description" : "Filter by continous_service_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recent_hire_date]", "in" : "query", "description" : "Filter by recent_hire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_district_code]", "in" : "query", "description" : "Filter by workday_district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_region]", "in" : "query", "description" : "Filter by workday_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_super_region]", "in" : "query", "description" : "Filter by workday_super_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[buckets]", "in" : "query", "description" : "Filter by buckets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportsTo]", "in" : "query", "description" : "Filter by reportsTo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districts/{id}/relationships/tickets" : { "get" : { "description" : "Retrieve tickets references related to a tkpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticketsInfo]", "in" : "query", "description" : "Filter by ticketsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachments]", "in" : "query", "description" : "Filter by tkpAttachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentsCategorized]", "in" : "query", "description" : "Filter by attachmentsCategorized (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachmentsWithNotifications]", "in" : "query", "description" : "Filter by tkpAttachmentsWithNotifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkedTickets]", "in" : "query", "description" : "Filter by linkedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districts/{id}/relationships/visits" : { "get" : { "description" : "Retrieve visits references related to a tkpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[arrived]", "in" : "query", "description" : "Filter by arrived (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[departed]", "in" : "query", "description" : "Filter by departed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[synced_up]", "in" : "query", "description" : "Filter by synced_up (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_saved_local]", "in" : "query", "description" : "Filter by when_saved_local (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[photo_ident]", "in" : "query", "description" : "Filter by photo_ident (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[actor_id]", "in" : "query", "description" : "Filter by actor_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[opened]", "in" : "query", "description" : "Filter by opened (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visitLocation]", "in" : "query", "description" : "Filter by visitLocation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districts/{id}/relationships/usrs" : { "get" : { "description" : "Retrieve usrs references related to a tkpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prin_type]", "in" : "query", "description" : "Filter by prin_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[displayname]", "in" : "query", "description" : "Filter by displayname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_id]", "in" : "query", "description" : "Filter by billing_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loginname]", "in" : "query", "description" : "Filter by loginname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstname]", "in" : "query", "description" : "Filter by firstname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastname]", "in" : "query", "description" : "Filter by lastname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportingnode]", "in" : "query", "description" : "Filter by reportingnode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activeuser]", "in" : "query", "description" : "Filter by activeuser (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_expires]", "in" : "query", "description" : "Filter by password_expires (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_sync_date]", "in" : "query", "description" : "Filter by last_sync_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_number]", "in" : "query", "description" : "Filter by employee_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[timesheet_start_date]", "in" : "query", "description" : "Filter by timesheet_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[timesheet_end_date]", "in" : "query", "description" : "Filter by timesheet_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_project_id]", "in" : "query", "description" : "Filter by default_project_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reports_to_id]", "in" : "query", "description" : "Filter by reports_to_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[login_for_customer_id]", "in" : "query", "description" : "Filter by login_for_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[department_number]", "in" : "query", "description" : "Filter by department_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[storage_id]", "in" : "query", "description" : "Filter by storage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[home_phone]", "in" : "query", "description" : "Filter by home_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_lockout]", "in" : "query", "description" : "Filter by password_lockout (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_crypt]", "in" : "query", "description" : "Filter by password_crypt (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[failed_logins]", "in" : "query", "description" : "Filter by failed_logins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_number]", "in" : "query", "description" : "Filter by district_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_area]", "in" : "query", "description" : "Filter by work_area (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[peoplesoft_id]", "in" : "query", "description" : "Filter by peoplesoft_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor_group_id]", "in" : "query", "description" : "Filter by supervisor_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_district_id]", "in" : "query", "description" : "Filter by effective_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_supervisor_group_id]", "in" : "query", "description" : "Filter by effective_supervisor_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[truck_number]", "in" : "query", "description" : "Filter by truck_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[at_risk]", "in" : "query", "description" : "Filter by at_risk (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type]", "in" : "query", "description" : "Filter by type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_status]", "in" : "query", "description" : "Filter by user_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[certified]", "in" : "query", "description" : "Filter by certified (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[callout_format]", "in" : "query", "description" : "Filter by callout_format (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_six_ssn]", "in" : "query", "description" : "Filter by last_six_ssn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[org_super_region_id]", "in" : "query", "description" : "Filter by org_super_region_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[org_region_id]", "in" : "query", "description" : "Filter by org_region_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[communication_preference]", "in" : "query", "description" : "Filter by communication_preference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr_manager]", "in" : "query", "description" : "Filter by hr_manager (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[continous_service_date]", "in" : "query", "description" : "Filter by continous_service_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recent_hire_date]", "in" : "query", "description" : "Filter by recent_hire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_district_code]", "in" : "query", "description" : "Filter by workday_district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_region]", "in" : "query", "description" : "Filter by workday_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_super_region]", "in" : "query", "description" : "Filter by workday_super_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[buckets]", "in" : "query", "description" : "Filter by buckets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportsTo]", "in" : "query", "description" : "Filter by reportsTo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userLogins/{id}" : { "get" : { "description" : "Retrieve a userLogins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" }, { "$ref" : "#/components/parameters/UserLoginsFields" }, { "$ref" : "#/components/parameters/UserLoginsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserLoginsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserLoginsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserLogins", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserLoginsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserLogins", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserLoginsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserLoginsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/shareddata/1.0/userLogins" : { "get" : { "description" : "Retrieve a List of userLogins resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[session_id]", "in" : "query", "description" : "Filter by session_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[login_date]", "in" : "query", "description" : "Filter by login_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[browser_name]", "in" : "query", "description" : "Filter by browser_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[major_version]", "in" : "query", "description" : "Filter by major_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[minor_version]", "in" : "query", "description" : "Filter by minor_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_platform]", "in" : "query", "description" : "Filter by user_platform (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[screen_height]", "in" : "query", "description" : "Filter by screen_height (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[screen_width]", "in" : "query", "description" : "Filter by screen_width (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserLoginsFields" }, { "$ref" : "#/components/parameters/UserLoginsInclude" }, { "$ref" : "#/components/parameters/UserLoginsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserLoginsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserLoginsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserLogins", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserLoginsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserLoginsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserLoginsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userLogins/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a userLogins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userLogins relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userLogins relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userLogins relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/shareddata/1.0/userLogins/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a userLogins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userLogins relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userLogins relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userLogins relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserLoginsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/ticketpro/1.0/tickets/{id}" : { "get" : { "description" : "Retrieve a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Tickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Tickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets" : { "get" : { "description" : "Retrieve a List of tickets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticketsInfo]", "in" : "query", "description" : "Filter by ticketsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachments]", "in" : "query", "description" : "Filter by tkpAttachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentsCategorized]", "in" : "query", "description" : "Filter by attachmentsCategorized (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachmentsWithNotifications]", "in" : "query", "description" : "Filter by tkpAttachmentsWithNotifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkedTickets]", "in" : "query", "description" : "Filter by linkedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" }, { "$ref" : "#/components/parameters/TicketsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Tickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/locates" : { "get" : { "description" : "Retrieve locates related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/visits" : { "get" : { "description" : "Retrieve visits related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[arrived]", "in" : "query", "description" : "Filter by arrived (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[departed]", "in" : "query", "description" : "Filter by departed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[synced_up]", "in" : "query", "description" : "Filter by synced_up (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_saved_local]", "in" : "query", "description" : "Filter by when_saved_local (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[photo_ident]", "in" : "query", "description" : "Filter by photo_ident (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[actor_id]", "in" : "query", "description" : "Filter by actor_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[opened]", "in" : "query", "description" : "Filter by opened (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visitLocation]", "in" : "query", "description" : "Filter by visitLocation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/ticketsInfo" : { "get" : { "description" : "Retrieve ticketsInfo related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expires_date]", "in" : "query", "description" : "Filter by expires_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet]", "in" : "query", "description" : "Filter by meet (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lot_type]", "in" : "query", "description" : "Filter by lot_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lot_ownership]", "in" : "query", "description" : "Filter by lot_ownership (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_time_type]", "in" : "query", "description" : "Filter by work_time_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_date]", "in" : "query", "description" : "Filter by meet_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[area_id]", "in" : "query", "description" : "Filter by area_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_contractor]", "in" : "query", "description" : "Filter by master_contractor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eta]", "in" : "query", "description" : "Filter by eta (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_cn_reviewed]", "in" : "query", "description" : "Filter by sup_cn_reviewed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_cn_reviewed]", "in" : "query", "description" : "Filter by rms_cn_reviewed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_cn_map_sent]", "in" : "query", "description" : "Filter by rms_cn_map_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_cn_deferred]", "in" : "query", "description" : "Filter by rms_cn_deferred (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_eet_assigned]", "in" : "query", "description" : "Filter by rms_eet_assigned (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsInfoFields" }, { "$ref" : "#/components/parameters/TicketsInfoInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsInfoResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsInfoResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/dueDateExtensions" : { "get" : { "description" : "Retrieve dueDateExtensions related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr_id]", "in" : "query", "description" : "Filter by usr_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_extended]", "in" : "query", "description" : "Filter by when_extended (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[due_date]", "in" : "query", "description" : "Filter by due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver_phone]", "in" : "query", "description" : "Filter by approver_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[old_due_date]", "in" : "query", "description" : "Filter by old_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_entered]", "in" : "query", "description" : "Filter by when_entered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsFields" }, { "$ref" : "#/components/parameters/DueDateExtensionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DueDateExtensionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/transmission" : { "get" : { "description" : "Retrieve transmissions related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/tkpDistrict" : { "get" : { "description" : "Retrieve tkpDistricts related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpDistrictsFields" }, { "$ref" : "#/components/parameters/TkpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpDistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/cpClosedTickets" : { "get" : { "description" : "Retrieve ticketCloseds related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketClosedsFields" }, { "$ref" : "#/components/parameters/TicketClosedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketClosedsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/tkpAttachments" : { "get" : { "description" : "Retrieve tkpAttachment related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[attachment_type]", "in" : "query", "description" : "Filter by attachment_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_id]", "in" : "query", "description" : "Filter by attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_kind]", "in" : "query", "description" : "Filter by entity_kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_id]", "in" : "query", "description" : "Filter by entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attached_by]", "in" : "query", "description" : "Filter by attached_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_attached]", "in" : "query", "description" : "Filter by when_attached (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_uploaded]", "in" : "query", "description" : "Filter by when_uploaded (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_name]", "in" : "query", "description" : "Filter by file_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_size]", "in" : "query", "description" : "Filter by file_size (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hash]", "in" : "query", "description" : "Filter by hash (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_time]", "in" : "query", "description" : "Filter by created_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_ticket_number]", "in" : "query", "description" : "Filter by original_ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentTag]", "in" : "query", "description" : "Filter by attachmentTag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentFields" }, { "$ref" : "#/components/parameters/TkpAttachmentInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/attachmentsCategorized" : { "get" : { "description" : "Retrieve attachmentsCategorized related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_id]", "in" : "query", "description" : "Filter by attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_name]", "in" : "query", "description" : "Filter by file_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[generated_at]", "in" : "query", "description" : "Filter by generated_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[received_at]", "in" : "query", "description" : "Filter by received_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[photo_category]", "in" : "query", "description" : "Filter by photo_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passed]", "in" : "query", "description" : "Filter by passed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passed_override_by_id]", "in" : "query", "description" : "Filter by passed_override_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passed_override_at]", "in" : "query", "description" : "Filter by passed_override_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purpose]", "in" : "query", "description" : "Filter by purpose (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[probability]", "in" : "query", "description" : "Filter by probability (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual_category]", "in" : "query", "description" : "Filter by manual_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual_category_at]", "in" : "query", "description" : "Filter by manual_category_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual_category_by_id]", "in" : "query", "description" : "Filter by manual_category_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_facility_type]", "in" : "query", "description" : "Filter by customer_facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentsCategorizedFields" }, { "$ref" : "#/components/parameters/AttachmentsCategorizedInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/projectTicket" : { "get" : { "description" : "Retrieve projectTickets related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/tkpAttachmentsWithNotifications" : { "get" : { "description" : "Retrieve attachmentsWithNotifications related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[attachment_type]", "in" : "query", "description" : "Filter by attachment_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_id]", "in" : "query", "description" : "Filter by attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_kind]", "in" : "query", "description" : "Filter by entity_kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_id]", "in" : "query", "description" : "Filter by entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attached_by]", "in" : "query", "description" : "Filter by attached_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_attached]", "in" : "query", "description" : "Filter by when_attached (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_uploaded]", "in" : "query", "description" : "Filter by when_uploaded (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_name]", "in" : "query", "description" : "Filter by file_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_size]", "in" : "query", "description" : "Filter by file_size (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hash]", "in" : "query", "description" : "Filter by hash (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_time]", "in" : "query", "description" : "Filter by created_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_ticket_number]", "in" : "query", "description" : "Filter by original_ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentTag]", "in" : "query", "description" : "Filter by attachmentTag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsFields" }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/activityPathPoints" : { "get" : { "description" : "Retrieve activityPathPoints related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[group_index]", "in" : "query", "description" : "Filter by group_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[order_index]", "in" : "query", "description" : "Filter by order_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_captured]", "in" : "query", "description" : "Filter by when_captured (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source]", "in" : "query", "description" : "Filter by source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[survey_id]", "in" : "query", "description" : "Filter by survey_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsFields" }, { "$ref" : "#/components/parameters/ActivityPathPointsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivityPathPointsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/locates" : { "get" : { "description" : "Retrieve locates references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/visits" : { "get" : { "description" : "Retrieve visits references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[arrived]", "in" : "query", "description" : "Filter by arrived (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[departed]", "in" : "query", "description" : "Filter by departed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[synced_up]", "in" : "query", "description" : "Filter by synced_up (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_saved_local]", "in" : "query", "description" : "Filter by when_saved_local (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[photo_ident]", "in" : "query", "description" : "Filter by photo_ident (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[actor_id]", "in" : "query", "description" : "Filter by actor_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[opened]", "in" : "query", "description" : "Filter by opened (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visitLocation]", "in" : "query", "description" : "Filter by visitLocation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/ticketsInfo" : { "get" : { "description" : "Retrieve ticketsInfo references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expires_date]", "in" : "query", "description" : "Filter by expires_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet]", "in" : "query", "description" : "Filter by meet (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lot_type]", "in" : "query", "description" : "Filter by lot_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lot_ownership]", "in" : "query", "description" : "Filter by lot_ownership (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_time_type]", "in" : "query", "description" : "Filter by work_time_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_date]", "in" : "query", "description" : "Filter by meet_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[area_id]", "in" : "query", "description" : "Filter by area_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_contractor]", "in" : "query", "description" : "Filter by master_contractor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eta]", "in" : "query", "description" : "Filter by eta (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_cn_reviewed]", "in" : "query", "description" : "Filter by sup_cn_reviewed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_cn_reviewed]", "in" : "query", "description" : "Filter by rms_cn_reviewed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_cn_map_sent]", "in" : "query", "description" : "Filter by rms_cn_map_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_cn_deferred]", "in" : "query", "description" : "Filter by rms_cn_deferred (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_eet_assigned]", "in" : "query", "description" : "Filter by rms_eet_assigned (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsInfoFields" }, { "$ref" : "#/components/parameters/TicketsInfoInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsInfoResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsInfoResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/dueDateExtensions" : { "get" : { "description" : "Retrieve dueDateExtensions references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr_id]", "in" : "query", "description" : "Filter by usr_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_extended]", "in" : "query", "description" : "Filter by when_extended (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[due_date]", "in" : "query", "description" : "Filter by due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver_phone]", "in" : "query", "description" : "Filter by approver_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[old_due_date]", "in" : "query", "description" : "Filter by old_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_entered]", "in" : "query", "description" : "Filter by when_entered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsFields" }, { "$ref" : "#/components/parameters/DueDateExtensionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/transmission" : { "get" : { "description" : "Retrieve transmissions references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/tkpDistrict" : { "get" : { "description" : "Retrieve tkpDistricts references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpDistrictsFields" }, { "$ref" : "#/components/parameters/TkpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/cpClosedTickets" : { "get" : { "description" : "Retrieve ticketCloseds references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketClosedsFields" }, { "$ref" : "#/components/parameters/TicketClosedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/tkpAttachments" : { "get" : { "description" : "Retrieve tkpAttachment references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[attachment_type]", "in" : "query", "description" : "Filter by attachment_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_id]", "in" : "query", "description" : "Filter by attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_kind]", "in" : "query", "description" : "Filter by entity_kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_id]", "in" : "query", "description" : "Filter by entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attached_by]", "in" : "query", "description" : "Filter by attached_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_attached]", "in" : "query", "description" : "Filter by when_attached (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_uploaded]", "in" : "query", "description" : "Filter by when_uploaded (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_name]", "in" : "query", "description" : "Filter by file_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_size]", "in" : "query", "description" : "Filter by file_size (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hash]", "in" : "query", "description" : "Filter by hash (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_time]", "in" : "query", "description" : "Filter by created_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_ticket_number]", "in" : "query", "description" : "Filter by original_ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentTag]", "in" : "query", "description" : "Filter by attachmentTag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentFields" }, { "$ref" : "#/components/parameters/TkpAttachmentInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/attachmentsCategorized" : { "get" : { "description" : "Retrieve attachmentsCategorized references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_id]", "in" : "query", "description" : "Filter by attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_name]", "in" : "query", "description" : "Filter by file_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[generated_at]", "in" : "query", "description" : "Filter by generated_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[received_at]", "in" : "query", "description" : "Filter by received_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[photo_category]", "in" : "query", "description" : "Filter by photo_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passed]", "in" : "query", "description" : "Filter by passed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passed_override_by_id]", "in" : "query", "description" : "Filter by passed_override_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passed_override_at]", "in" : "query", "description" : "Filter by passed_override_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purpose]", "in" : "query", "description" : "Filter by purpose (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[probability]", "in" : "query", "description" : "Filter by probability (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual_category]", "in" : "query", "description" : "Filter by manual_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual_category_at]", "in" : "query", "description" : "Filter by manual_category_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual_category_by_id]", "in" : "query", "description" : "Filter by manual_category_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_facility_type]", "in" : "query", "description" : "Filter by customer_facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentsCategorizedFields" }, { "$ref" : "#/components/parameters/AttachmentsCategorizedInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/projectTicket" : { "get" : { "description" : "Retrieve projectTickets references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/tkpAttachmentsWithNotifications" : { "get" : { "description" : "Retrieve attachmentsWithNotifications references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[attachment_type]", "in" : "query", "description" : "Filter by attachment_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_id]", "in" : "query", "description" : "Filter by attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_kind]", "in" : "query", "description" : "Filter by entity_kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_id]", "in" : "query", "description" : "Filter by entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attached_by]", "in" : "query", "description" : "Filter by attached_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_attached]", "in" : "query", "description" : "Filter by when_attached (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_uploaded]", "in" : "query", "description" : "Filter by when_uploaded (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_name]", "in" : "query", "description" : "Filter by file_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_size]", "in" : "query", "description" : "Filter by file_size (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hash]", "in" : "query", "description" : "Filter by hash (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_time]", "in" : "query", "description" : "Filter by created_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_ticket_number]", "in" : "query", "description" : "Filter by original_ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentTag]", "in" : "query", "description" : "Filter by attachmentTag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsFields" }, { "$ref" : "#/components/parameters/AttachmentsWithNotificationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentsWithNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/tickets/{id}/relationships/activityPathPoints" : { "get" : { "description" : "Retrieve activityPathPoints references related to a tickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[group_index]", "in" : "query", "description" : "Filter by group_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[order_index]", "in" : "query", "description" : "Filter by order_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_captured]", "in" : "query", "description" : "Filter by when_captured (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source]", "in" : "query", "description" : "Filter by source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[survey_id]", "in" : "query", "description" : "Filter by survey_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsFields" }, { "$ref" : "#/components/parameters/ActivityPathPointsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/lawFirms/{id}" : { "get" : { "description" : "Retrieve a lawFirms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LawFirmsPrimaryKey" }, { "$ref" : "#/components/parameters/LawFirmsFields" }, { "$ref" : "#/components/parameters/LawFirmsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LawFirmsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LawFirmsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a LawFirms", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LawFirmsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LawFirmsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a LawFirms", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LawFirmsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LawFirmsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LawFirmsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/lawFirms" : { "get" : { "description" : "Retrieve a List of lawFirms resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCases]", "in" : "query", "description" : "Filter by legalCases (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParties]", "in" : "query", "description" : "Filter by legalParties (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LawFirmsFields" }, { "$ref" : "#/components/parameters/LawFirmsInclude" }, { "$ref" : "#/components/parameters/LawFirmsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LawFirmsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LawFirmsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a LawFirms", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LawFirmsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LawFirmsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LawFirmsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/lawFirms/{id}/legalCases" : { "get" : { "description" : "Retrieve legalCases related to a lawFirms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LawFirmsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_id]", "in" : "query", "description" : "Filter by cases_sub_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_manager_id]", "in" : "query", "description" : "Filter by case_manager_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_adjuster_id]", "in" : "query", "description" : "Filter by insurance_adjuster_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_id]", "in" : "query", "description" : "Filter by legal_party_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sued_by_type_id]", "in" : "query", "description" : "Filter by sued_by_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_site_id]", "in" : "query", "description" : "Filter by law_firm_site_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_name]", "in" : "query", "description" : "Filter by case_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[litigation_status_id]", "in" : "query", "description" : "Filter by litigation_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_served]", "in" : "query", "description" : "Filter by date_served (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_sent_to_attorney]", "in" : "query", "description" : "Filter by date_sent_to_attorney (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[matter_number]", "in" : "query", "description" : "Filter by matter_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[court_case_number]", "in" : "query", "description" : "Filter by court_case_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_agreed_date]", "in" : "query", "description" : "Filter by damage_agreed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_claim]", "in" : "query", "description" : "Filter by insurance_claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_status]", "in" : "query", "description" : "Filter by case_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trial_date]", "in" : "query", "description" : "Filter by trial_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mediation_date]", "in" : "query", "description" : "Filter by mediation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParty]", "in" : "query", "description" : "Filter by legalParty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtype]", "in" : "query", "description" : "Filter by casesSubtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/lawFirms/{id}/legalParties" : { "get" : { "description" : "Retrieve legalParties related to a lawFirms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LawFirmsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_type_id]", "in" : "query", "description" : "Filter by legal_party_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_name]", "in" : "query", "description" : "Filter by first_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_name]", "in" : "query", "description" : "Filter by last_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[middle_name]", "in" : "query", "description" : "Filter by middle_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[preferred_name]", "in" : "query", "description" : "Filter by preferred_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCases]", "in" : "query", "description" : "Filter by legalCases (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalPartiesFields" }, { "$ref" : "#/components/parameters/LegalPartiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalPartiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/lawFirms/{id}/relationships/legalCases" : { "get" : { "description" : "Retrieve legalCases references related to a lawFirms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LawFirmsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_id]", "in" : "query", "description" : "Filter by cases_sub_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_manager_id]", "in" : "query", "description" : "Filter by case_manager_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_adjuster_id]", "in" : "query", "description" : "Filter by insurance_adjuster_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_id]", "in" : "query", "description" : "Filter by legal_party_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sued_by_type_id]", "in" : "query", "description" : "Filter by sued_by_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_site_id]", "in" : "query", "description" : "Filter by law_firm_site_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_name]", "in" : "query", "description" : "Filter by case_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[litigation_status_id]", "in" : "query", "description" : "Filter by litigation_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_served]", "in" : "query", "description" : "Filter by date_served (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_sent_to_attorney]", "in" : "query", "description" : "Filter by date_sent_to_attorney (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[matter_number]", "in" : "query", "description" : "Filter by matter_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[court_case_number]", "in" : "query", "description" : "Filter by court_case_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_agreed_date]", "in" : "query", "description" : "Filter by damage_agreed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_claim]", "in" : "query", "description" : "Filter by insurance_claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_status]", "in" : "query", "description" : "Filter by case_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trial_date]", "in" : "query", "description" : "Filter by trial_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mediation_date]", "in" : "query", "description" : "Filter by mediation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParty]", "in" : "query", "description" : "Filter by legalParty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtype]", "in" : "query", "description" : "Filter by casesSubtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/lawFirms/{id}/relationships/legalParties" : { "get" : { "description" : "Retrieve legalParties references related to a lawFirms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LawFirmsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_type_id]", "in" : "query", "description" : "Filter by legal_party_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_name]", "in" : "query", "description" : "Filter by first_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_name]", "in" : "query", "description" : "Filter by last_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[middle_name]", "in" : "query", "description" : "Filter by middle_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[preferred_name]", "in" : "query", "description" : "Filter by preferred_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCases]", "in" : "query", "description" : "Filter by legalCases (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalPartiesFields" }, { "$ref" : "#/components/parameters/LegalPartiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileValues/{id}" : { "get" : { "description" : "Retrieve a profileValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" }, { "$ref" : "#/components/parameters/ProfileValuesFields" }, { "$ref" : "#/components/parameters/ProfileValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileValuesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ProfileValues", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ProfileValues", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileValuesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileValues" : { "get" : { "description" : "Retrieve a List of profileValues resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_id]", "in" : "query", "description" : "Filter by profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_level_id]", "in" : "query", "description" : "Filter by profile_level_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value_data_type]", "in" : "query", "description" : "Filter by value_data_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile]", "in" : "query", "description" : "Filter by profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profileLevel]", "in" : "query", "description" : "Filter by profileLevel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ProfileValuesFields" }, { "$ref" : "#/components/parameters/ProfileValuesInclude" }, { "$ref" : "#/components/parameters/ProfileValuesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileValuesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ProfileValues", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileValuesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileValuesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileValues/{id}/profile" : { "get" : { "description" : "Retrieve profiles related to a profileValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" }, { "$ref" : "#/components/parameters/ProfilesFields" }, { "$ref" : "#/components/parameters/ProfilesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create profileValues relationship to a profiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete profileValues relationship to a profiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update profileValues relationship to a profiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileValues/{id}/profileLevel" : { "get" : { "description" : "Retrieve profileLevels related to a profileValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" }, { "$ref" : "#/components/parameters/ProfileLevelsFields" }, { "$ref" : "#/components/parameters/ProfileLevelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create profileValues relationship to a profileLevels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete profileValues relationship to a profileLevels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update profileValues relationship to a profileLevels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileValues/{id}/relationships/profile" : { "get" : { "description" : "Retrieve profiles references related to a profileValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" }, { "$ref" : "#/components/parameters/ProfilesFields" }, { "$ref" : "#/components/parameters/ProfilesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create profileValues relationship to a profiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete profileValues relationship to a profiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update profileValues relationship to a profiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ProfilesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileValues/{id}/relationships/profileLevel" : { "get" : { "description" : "Retrieve profileLevels references related to a profileValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" }, { "$ref" : "#/components/parameters/ProfileLevelsFields" }, { "$ref" : "#/components/parameters/ProfileLevelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create profileValues relationship to a profileLevels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete profileValues relationship to a profileLevels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update profileValues relationship to a profileLevels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTypes/{id}" : { "get" : { "description" : "Retrieve a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTypesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetTypesFields" }, { "$ref" : "#/components/parameters/AssetTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTypesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTypesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTypes" : { "get" : { "description" : "Retrieve a List of assetTypes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributeMappings]", "in" : "query", "description" : "Filter by attributeMappings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMappings]", "in" : "query", "description" : "Filter by categoryTypeMakeMappings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetTypesFields" }, { "$ref" : "#/components/parameters/AssetTypesInclude" }, { "$ref" : "#/components/parameters/AssetTypesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTypes/{id}/attributeMappings" : { "get" : { "description" : "Retrieve attributeMappings related to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type_id]", "in" : "query", "description" : "Filter by asset_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTypes/{id}/categoryTypeMakeMappings" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings related to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_id]", "in" : "query", "description" : "Filter by type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_type_id]", "in" : "query", "description" : "Filter by category_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategory]", "in" : "query", "description" : "Filter by assetCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategoryType]", "in" : "query", "description" : "Filter by assetCategoryType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTypes/{id}/relationships/attributeMappings" : { "get" : { "description" : "Retrieve attributeMappings references related to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type_id]", "in" : "query", "description" : "Filter by asset_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetTypes/{id}/relationships/categoryTypeMakeMappings" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings references related to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_id]", "in" : "query", "description" : "Filter by type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_type_id]", "in" : "query", "description" : "Filter by category_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategory]", "in" : "query", "description" : "Filter by assetCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategoryType]", "in" : "query", "description" : "Filter by assetCategoryType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccountContractAccesses/{id}" : { "get" : { "description" : "Retrieve a userAccountContractAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/UserAccountContractAccessesFields" }, { "$ref" : "#/components/parameters/UserAccountContractAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserAccountContractAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserAccountContractAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountContractAccessesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccountContractAccesses" : { "get" : { "description" : "Retrieve a List of userAccountContractAccesses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_name]", "in" : "query", "description" : "Filter by cp_user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesFields" }, { "$ref" : "#/components/parameters/UserAccountContractAccessesInclude" }, { "$ref" : "#/components/parameters/UserAccountContractAccessesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserAccountContractAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountContractAccessesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccountContractAccesses/{id}/customerContract" : { "get" : { "description" : "Retrieve customerContracts related to a userAccountContractAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userAccountContractAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userAccountContractAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userAccountContractAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccountContractAccesses/{id}/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts related to a userAccountContractAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userAccountContractAccesses relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userAccountContractAccesses relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userAccountContractAccesses relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccountContractAccesses/{id}/relationships/customerContract" : { "get" : { "description" : "Retrieve customerContracts references related to a userAccountContractAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userAccountContractAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userAccountContractAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userAccountContractAccesses relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userAccountContractAccesses/{id}/relationships/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts references related to a userAccountContractAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userAccountContractAccesses relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userAccountContractAccesses relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userAccountContractAccesses relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/errorLogs/{id}" : { "get" : { "description" : "Retrieve a errorLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ErrorLogsPrimaryKey" }, { "$ref" : "#/components/parameters/ErrorLogsFields" }, { "$ref" : "#/components/parameters/ErrorLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ErrorLogsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ErrorLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ErrorLogsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ErrorLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ErrorLogsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ErrorLogsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/errorLogs" : { "get" : { "description" : "Retrieve a List of errorLogs resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[severity]", "in" : "query", "description" : "Filter by severity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[error_state]", "in" : "query", "description" : "Filter by error_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[module]", "in" : "query", "description" : "Filter by module (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[line_no]", "in" : "query", "description" : "Filter by line_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[creation_date]", "in" : "query", "description" : "Filter by creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ErrorLogsFields" }, { "$ref" : "#/components/parameters/ErrorLogsInclude" }, { "$ref" : "#/components/parameters/ErrorLogsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ErrorLogsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ErrorLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ErrorLogsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ErrorLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ErrorLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachments/{id}" : { "get" : { "description" : "Retrieve a tkpAttachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/TkpAttachmentFields" }, { "$ref" : "#/components/parameters/TkpAttachmentInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TkpAttachment", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TkpAttachment", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpAttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachments" : { "get" : { "description" : "Retrieve a List of tkpAttachment resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[attachment_type]", "in" : "query", "description" : "Filter by attachment_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_id]", "in" : "query", "description" : "Filter by attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_kind]", "in" : "query", "description" : "Filter by entity_kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_id]", "in" : "query", "description" : "Filter by entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attached_by]", "in" : "query", "description" : "Filter by attached_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_attached]", "in" : "query", "description" : "Filter by when_attached (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_uploaded]", "in" : "query", "description" : "Filter by when_uploaded (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_name]", "in" : "query", "description" : "Filter by file_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_size]", "in" : "query", "description" : "Filter by file_size (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hash]", "in" : "query", "description" : "Filter by hash (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_time]", "in" : "query", "description" : "Filter by created_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_ticket_number]", "in" : "query", "description" : "Filter by original_ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentTag]", "in" : "query", "description" : "Filter by attachmentTag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentFields" }, { "$ref" : "#/components/parameters/TkpAttachmentInclude" }, { "$ref" : "#/components/parameters/TkpAttachmentSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TkpAttachment", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpAttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachments/{id}/attachmentTag" : { "get" : { "description" : "Retrieve tkpAttachmentTags related to a tkpAttachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsFields" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachments/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a tkpAttachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachments/{id}/relationships/attachmentTag" : { "get" : { "description" : "Retrieve tkpAttachmentTags references related to a tkpAttachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsFields" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachments/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a tkpAttachment resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideaKinds/{id}" : { "get" : { "description" : "Retrieve a ideaKinds resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeaKindsPrimaryKey" }, { "$ref" : "#/components/parameters/IdeaKindsFields" }, { "$ref" : "#/components/parameters/IdeaKindsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeaKindsResourceResponse" }, "202" : { "$ref" : "#/components/responses/IdeaKindsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a IdeaKinds", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeaKindsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/IdeaKindsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a IdeaKinds", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/IdeaKindsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeaKindsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/IdeaKindsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/ideaKinds" : { "get" : { "description" : "Retrieve a List of ideaKinds resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sort_order]", "in" : "query", "description" : "Filter by sort_order (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/IdeaKindsFields" }, { "$ref" : "#/components/parameters/IdeaKindsInclude" }, { "$ref" : "#/components/parameters/IdeaKindsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeaKindsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/IdeaKindsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a IdeaKinds", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeaKindsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeaKindsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/IdeaKindsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/repairReasons/{id}" : { "get" : { "description" : "Retrieve a repairReasons resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RepairReasonsPrimaryKey" }, { "$ref" : "#/components/parameters/RepairReasonsFields" }, { "$ref" : "#/components/parameters/RepairReasonsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourceResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a RepairReasons", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RepairReasonsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a RepairReasons", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RepairReasonsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/repairReasons" : { "get" : { "description" : "Retrieve a List of repairReasons resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RepairReasonsFields" }, { "$ref" : "#/components/parameters/RepairReasonsInclude" }, { "$ref" : "#/components/parameters/RepairReasonsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a RepairReasons", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/repairReasons/{id}/assets" : { "get" : { "description" : "Retrieve assets related to a repairReasons resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RepairReasonsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/repairReasons/{id}/relationships/assets" : { "get" : { "description" : "Retrieve assets references related to a repairReasons resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RepairReasonsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccesses/{id}" : { "get" : { "description" : "Retrieve a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/UserDataAccessesFields" }, { "$ref" : "#/components/parameters/UserDataAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserDataAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserDataAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccesses" : { "get" : { "description" : "Retrieve a List of userDataAccesses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_districts]", "in" : "query", "description" : "Filter by all_districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_supgroups]", "in" : "query", "description" : "Filter by all_supgroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesFields" }, { "$ref" : "#/components/parameters/UserDataAccessesInclude" }, { "$ref" : "#/components/parameters/UserDataAccessesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserDataAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccesses/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccesses/{id}/application" : { "get" : { "description" : "Retrieve applications related to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/ApplicationsFields" }, { "$ref" : "#/components/parameters/ApplicationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userDataAccesses relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userDataAccesses relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userDataAccesses relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccesses/{id}/dist" : { "get" : { "description" : "Retrieve districts related to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccesses/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccesses/{id}/relationships/application" : { "get" : { "description" : "Retrieve applications references related to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/ApplicationsFields" }, { "$ref" : "#/components/parameters/ApplicationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create userDataAccesses relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete userDataAccesses relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update userDataAccesses relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccesses/{id}/relationships/dist" : { "get" : { "description" : "Retrieve districts references related to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/announcements/{id}" : { "get" : { "description" : "Retrieve a announcements resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AnnouncementsPrimaryKey" }, { "$ref" : "#/components/parameters/AnnouncementsFields" }, { "$ref" : "#/components/parameters/AnnouncementsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Announcements", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AnnouncementsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Announcements", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AnnouncementsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/announcements" : { "get" : { "description" : "Retrieve a List of announcements resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[announcement_text]", "in" : "query", "description" : "Filter by announcement_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_priority]", "in" : "query", "description" : "Filter by high_priority (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AnnouncementsFields" }, { "$ref" : "#/components/parameters/AnnouncementsInclude" }, { "$ref" : "#/components/parameters/AnnouncementsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Announcements", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/announcements/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a announcements resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AnnouncementsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/announcements/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a announcements resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AnnouncementsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobStatuses/{id}" : { "get" : { "description" : "Retrieve a schedulerJobStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobStatusesPrimaryKey" }, { "$ref" : "#/components/parameters/SchedulerJobStatusesFields" }, { "$ref" : "#/components/parameters/SchedulerJobStatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a SchedulerJobStatuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobStatusesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a SchedulerJobStatuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobStatusesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobStatuses" : { "get" : { "description" : "Retrieve a List of schedulerJobStatuses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobsInfo]", "in" : "query", "description" : "Filter by schedulerJobsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SchedulerJobStatusesFields" }, { "$ref" : "#/components/parameters/SchedulerJobStatusesInclude" }, { "$ref" : "#/components/parameters/SchedulerJobStatusesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a SchedulerJobStatuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobStatuses/{id}/schedulerJobsInfo" : { "get" : { "description" : "Retrieve schedulerJobs related to a schedulerJobStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobStatusesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_group]", "in" : "query", "description" : "Filter by job_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_class]", "in" : "query", "description" : "Filter by job_class (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_expression]", "in" : "query", "description" : "Filter by cron_expression (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repeat_time]", "in" : "query", "description" : "Filter by repeat_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_job]", "in" : "query", "description" : "Filter by cron_job (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[time_zone]", "in" : "query", "description" : "Filter by time_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parameters]", "in" : "query", "description" : "Filter by parameters (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[jobInfo]", "in" : "query", "description" : "Filter by jobInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobStatus]", "in" : "query", "description" : "Filter by schedulerJobStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsFields" }, { "$ref" : "#/components/parameters/SchedulerJobsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobStatuses/{id}/relationships/schedulerJobsInfo" : { "get" : { "description" : "Retrieve schedulerJobs references related to a schedulerJobStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobStatusesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_group]", "in" : "query", "description" : "Filter by job_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_class]", "in" : "query", "description" : "Filter by job_class (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_expression]", "in" : "query", "description" : "Filter by cron_expression (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repeat_time]", "in" : "query", "description" : "Filter by repeat_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_job]", "in" : "query", "description" : "Filter by cron_job (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[time_zone]", "in" : "query", "description" : "Filter by time_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parameters]", "in" : "query", "description" : "Filter by parameters (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[jobInfo]", "in" : "query", "description" : "Filter by jobInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobStatus]", "in" : "query", "description" : "Filter by schedulerJobStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsFields" }, { "$ref" : "#/components/parameters/SchedulerJobsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userProfiles/{id}" : { "get" : { "description" : "Retrieve a userProfiles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserProfilesPrimaryKey" }, { "$ref" : "#/components/parameters/UserProfilesFields" }, { "$ref" : "#/components/parameters/UserProfilesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserProfilesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserProfiles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserProfilesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserProfiles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserProfilesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserProfilesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userProfiles" : { "get" : { "description" : "Retrieve a List of userProfiles resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_name]", "in" : "query", "description" : "Filter by cp_user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_name]", "in" : "query", "description" : "Filter by first_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_name]", "in" : "query", "description" : "Filter by last_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[middle_name]", "in" : "query", "description" : "Filter by middle_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[preferred_name]", "in" : "query", "description" : "Filter by preferred_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email_address]", "in" : "query", "description" : "Filter by email_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile_phone]", "in" : "query", "description" : "Filter by mobile_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_date]", "in" : "query", "description" : "Filter by password_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_logged_on]", "in" : "query", "description" : "Filter by last_logged_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserProfilesFields" }, { "$ref" : "#/components/parameters/UserProfilesInclude" }, { "$ref" : "#/components/parameters/UserProfilesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserProfilesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserProfiles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserProfilesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserProfilesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalRisks/{id}" : { "get" : { "description" : "Retrieve a legalRisks resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalRisksPrimaryKey" }, { "$ref" : "#/components/parameters/LegalRisksFields" }, { "$ref" : "#/components/parameters/LegalRisksInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalRisksResourceResponse" }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a LegalRisks", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalRisksPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a LegalRisks", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalRisksPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalRisksPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalRisks" : { "get" : { "description" : "Retrieve a List of legalRisks resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_risk_id]", "in" : "query", "description" : "Filter by legal_risk_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawsuit_demand_amount]", "in" : "query", "description" : "Filter by lawsuit_demand_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate]", "in" : "query", "description" : "Filter by estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_flag]", "in" : "query", "description" : "Filter by accrual_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[liability_age]", "in" : "query", "description" : "Filter by liability_age (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_reserve]", "in" : "query", "description" : "Filter by settlement_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_reserve]", "in" : "query", "description" : "Filter by expense_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_accrual_balance]", "in" : "query", "description" : "Filter by expense_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_accrual_balance]", "in" : "query", "description" : "Filter by settlement_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalRisksFields" }, { "$ref" : "#/components/parameters/LegalRisksInclude" }, { "$ref" : "#/components/parameters/LegalRisksSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalRisksResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a LegalRisks", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalRisksPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalRisksResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalRisks/{id}/legalCase" : { "get" : { "description" : "Retrieve legalCases related to a legalRisks resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalRisksPrimaryKey" }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalRisks/{id}/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods related to a legalRisks resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalRisksPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalRisks/{id}/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests related to a legalRisks resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalRisksPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalRisks/{id}/relationships/legalCase" : { "get" : { "description" : "Retrieve legalCases references related to a legalRisks resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalRisksPrimaryKey" }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalRisks/{id}/relationships/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods references related to a legalRisks resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalRisksPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalRisks/{id}/relationships/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests references related to a legalRisks resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalRisksPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}" : { "get" : { "description" : "Retrieve a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a LocateOpenSnapshots", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a LocateOpenSnapshots", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots" : { "get" : { "description" : "Retrieve a List of locateOpenSnapshots resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsInclude" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a LocateOpenSnapshots", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/bucket" : { "get" : { "description" : "Retrieve buckets related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/transmissionExtra" : { "get" : { "description" : "Retrieve transmissionExtras related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/transmission" : { "get" : { "description" : "Retrieve transmissions related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/latestActivity" : { "get" : { "description" : "Retrieve activities related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/firstClosingActivity" : { "get" : { "description" : "Retrieve activities related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/term" : { "get" : { "description" : "Retrieve terms related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/termUtilityMap" : { "get" : { "description" : "Retrieve termUtilityMaps related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TermUtilityMapsFields" }, { "$ref" : "#/components/parameters/TermUtilityMapsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermUtilityMapsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/activities" : { "get" : { "description" : "Retrieve activities related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/projectTicket" : { "get" : { "description" : "Retrieve projectTickets related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/utility" : { "get" : { "description" : "Retrieve utilities related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/bucket" : { "get" : { "description" : "Retrieve buckets references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmissionExtra" : { "get" : { "description" : "Retrieve transmissionExtras references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmission" : { "get" : { "description" : "Retrieve transmissions references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/latestActivity" : { "get" : { "description" : "Retrieve activities references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/firstClosingActivity" : { "get" : { "description" : "Retrieve activities references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/term" : { "get" : { "description" : "Retrieve terms references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/termUtilityMap" : { "get" : { "description" : "Retrieve termUtilityMaps references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TermUtilityMapsFields" }, { "$ref" : "#/components/parameters/TermUtilityMapsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/activities" : { "get" : { "description" : "Retrieve activities references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/projectTicket" : { "get" : { "description" : "Retrieve projectTickets references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/utility" : { "get" : { "description" : "Retrieve utilities references related to a locateOpenSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireQuestions/{id}" : { "get" : { "description" : "Retrieve a questionnaireQuestions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsPrimaryKey" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsFields" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a QuestionnaireQuestions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a QuestionnaireQuestions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireQuestions" : { "get" : { "description" : "Retrieve a List of questionnaireQuestions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[label]", "in" : "query", "description" : "Filter by label (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq]", "in" : "query", "description" : "Filter by seq (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[placement]", "in" : "query", "description" : "Filter by placement (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_question]", "in" : "query", "description" : "Filter by master_question (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[criteria]", "in" : "query", "description" : "Filter by criteria (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type]", "in" : "query", "description" : "Filter by type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visibility]", "in" : "query", "description" : "Filter by visibility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required]", "in" : "query", "description" : "Filter by required (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireAnswers]", "in" : "query", "description" : "Filter by questionnaireAnswers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsFields" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsInclude" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a QuestionnaireQuestions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireQuestions/{id}/questionnaireAnswers" : { "get" : { "description" : "Retrieve questionnaireAnswers related to a questionnaireQuestions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[question_id]", "in" : "query", "description" : "Filter by question_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[answer]", "in" : "query", "description" : "Filter by answer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireQuestion]", "in" : "query", "description" : "Filter by questionnaireQuestion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersFields" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireQuestions/{id}/relationships/questionnaireAnswers" : { "get" : { "description" : "Retrieve questionnaireAnswers references related to a questionnaireQuestions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[question_id]", "in" : "query", "description" : "Filter by question_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[answer]", "in" : "query", "description" : "Filter by answer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireQuestion]", "in" : "query", "description" : "Filter by questionnaireQuestion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersFields" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locatorCheckins/{id}" : { "get" : { "description" : "Retrieve a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" }, { "$ref" : "#/components/parameters/LocatorCheckinsFields" }, { "$ref" : "#/components/parameters/LocatorCheckinsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a LocatorCheckins", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a LocatorCheckins", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locatorCheckins" : { "get" : { "description" : "Retrieve a List of locatorCheckins resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[checkin_action]", "in" : "query", "description" : "Filter by checkin_action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_version]", "in" : "query", "description" : "Filter by asset_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_on]", "in" : "query", "description" : "Filter by reviewed_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsFields" }, { "$ref" : "#/components/parameters/LocatorCheckinsInclude" }, { "$ref" : "#/components/parameters/LocatorCheckinsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a LocatorCheckins", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locatorCheckins/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locatorCheckins/{id}/asset" : { "get" : { "description" : "Retrieve assets related to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create locatorCheckins relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete locatorCheckins relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update locatorCheckins relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locatorCheckins/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locatorCheckins/{id}/relationships/asset" : { "get" : { "description" : "Retrieve assets references related to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create locatorCheckins relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete locatorCheckins relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update locatorCheckins relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}" : { "get" : { "description" : "Retrieve a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a InvestigationDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a InvestigationDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails" : { "get" : { "description" : "Retrieve a List of investigationDetails resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_investigation_id]", "in" : "query", "description" : "Filter by id_investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_notification_id]", "in" : "query", "description" : "Filter by id_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_damage_id]", "in" : "query", "description" : "Filter by id_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_customer_id]", "in" : "query", "description" : "Filter by id_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_account_level_customer_id]", "in" : "query", "description" : "Filter by id_account_level_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_damage_customer]", "in" : "query", "description" : "Filter by id_damage_customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_utility]", "in" : "query", "description" : "Filter by id_utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility]", "in" : "query", "description" : "Filter by id_facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility_type]", "in" : "query", "description" : "Filter by id_facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_locator_name]", "in" : "query", "description" : "Filter by id_locator_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_cause_factor]", "in" : "query", "description" : "Filter by id_cause_factor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_were_markings_visible]", "in" : "query", "description" : "Filter by id_were_markings_visible (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_other_indicators]", "in" : "query", "description" : "Filter by id_other_indicators (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_tolerence_zone]", "in" : "query", "description" : "Filter by id_tolerence_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility_damage]", "in" : "query", "description" : "Filter by id_facility_damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_replacement_footage]", "in" : "query", "description" : "Filter by id_replacement_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_contractor_assistance]", "in" : "query", "description" : "Filter by id_contractor_assistance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_contractor_equipment]", "in" : "query", "description" : "Filter by id_contractor_equipment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility_shown]", "in" : "query", "description" : "Filter by id_facility_shown (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_record_numbers]", "in" : "query", "description" : "Filter by id_record_numbers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_report_attachment_id]", "in" : "query", "description" : "Filter by inv_report_attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationReport]", "in" : "query", "description" : "Filter by investigationReport (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" }, { "$ref" : "#/components/parameters/InvestigationDetailsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a InvestigationDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/investigationReport" : { "get" : { "description" : "Retrieve damagePhotos related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagePhotosFields" }, { "$ref" : "#/components/parameters/DamagePhotosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/investigationDetailsVersions" : { "get" : { "description" : "Retrieve investigationDetailsVersions related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersion]", "in" : "query", "description" : "Filter by investigationVersion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completedBy]", "in" : "query", "description" : "Filter by completedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changedBy]", "in" : "query", "description" : "Filter by changedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/claimDetails" : { "get" : { "description" : "Retrieve claimDetails related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_variance_reason_id]", "in" : "query", "description" : "Filter by estimate_variance_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_accrual_balance]", "in" : "query", "description" : "Filter by retain_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_version_number]", "in" : "query", "description" : "Filter by estimate_version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_balance]", "in" : "query", "description" : "Filter by estimate_accrued_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_amount]", "in" : "query", "description" : "Filter by estimate_accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/relationships/investigationReport" : { "get" : { "description" : "Retrieve damagePhotos references related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagePhotosFields" }, { "$ref" : "#/components/parameters/DamagePhotosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/relationships/investigationDetailsVersions" : { "get" : { "description" : "Retrieve investigationDetailsVersions references related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersion]", "in" : "query", "description" : "Filter by investigationVersion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completedBy]", "in" : "query", "description" : "Filter by completedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changedBy]", "in" : "query", "description" : "Filter by changedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/relationships/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates references related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetails/{id}/relationships/claimDetails" : { "get" : { "description" : "Retrieve claimDetails references related to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_variance_reason_id]", "in" : "query", "description" : "Filter by estimate_variance_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_accrual_balance]", "in" : "query", "description" : "Filter by retain_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_version_number]", "in" : "query", "description" : "Filter by estimate_version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_balance]", "in" : "query", "description" : "Filter by estimate_accrued_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_amount]", "in" : "query", "description" : "Filter by estimate_accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireAnswers/{id}" : { "get" : { "description" : "Retrieve a questionnaireAnswers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersPrimaryKey" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersFields" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a QuestionnaireAnswers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a QuestionnaireAnswers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireAnswersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireAnswers" : { "get" : { "description" : "Retrieve a List of questionnaireAnswers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[question_id]", "in" : "query", "description" : "Filter by question_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[answer]", "in" : "query", "description" : "Filter by answer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireQuestion]", "in" : "query", "description" : "Filter by questionnaireQuestion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersFields" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersInclude" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a QuestionnaireAnswers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireAnswersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireAnswers/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a questionnaireAnswers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireAnswers/{id}/questionnaireQuestion" : { "get" : { "description" : "Retrieve questionnaireQuestions related to a questionnaireAnswers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersPrimaryKey" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsFields" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireAnswers/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a questionnaireAnswers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionnaireAnswers/{id}/relationships/questionnaireQuestion" : { "get" : { "description" : "Retrieve questionnaireQuestions references related to a questionnaireAnswers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersPrimaryKey" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsFields" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}" : { "get" : { "description" : "Retrieve a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Assets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Assets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets" : { "get" : { "description" : "Retrieve a List of assets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" }, { "$ref" : "#/components/parameters/AssetsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Assets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/dist" : { "get" : { "description" : "Retrieve districts related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/deletionType" : { "get" : { "description" : "Retrieve deletionTypes related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/DeletionTypesFields" }, { "$ref" : "#/components/parameters/DeletionTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a deletionTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a deletionTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a deletionTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/repairReason" : { "get" : { "description" : "Retrieve repairReasons related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/RepairReasonsFields" }, { "$ref" : "#/components/parameters/RepairReasonsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourceResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a repairReasons resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a repairReasons resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a repairReasons resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/locatorCheckins" : { "get" : { "description" : "Retrieve locatorCheckins related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[checkin_action]", "in" : "query", "description" : "Filter by checkin_action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_version]", "in" : "query", "description" : "Filter by asset_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_on]", "in" : "query", "description" : "Filter by reviewed_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsFields" }, { "$ref" : "#/components/parameters/LocatorCheckinsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/assetModel" : { "get" : { "description" : "Retrieve assetModels related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetModelsFields" }, { "$ref" : "#/components/parameters/AssetModelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/assetStatus" : { "get" : { "description" : "Retrieve assetStatuses related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetStatusesFields" }, { "$ref" : "#/components/parameters/AssetStatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a assetStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a assetStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a assetStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/categoryTypeMakeMapping" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/employeeAcceptedBy" : { "get" : { "description" : "Retrieve employees related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/assetAssignment" : { "get" : { "description" : "Retrieve assetAssignments related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/lastAssignment" : { "get" : { "description" : "Retrieve assetAssignments related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/location" : { "get" : { "description" : "Retrieve locations related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/assetAttributeValues" : { "get" : { "description" : "Retrieve assetAttributeValues related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[record_description]", "in" : "query", "description" : "Filter by record_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[update_process]", "in" : "query", "description" : "Filter by update_process (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesFields" }, { "$ref" : "#/components/parameters/AssetAttributeValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a assetAttributeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a assetAttributeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a assetAttributeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/netmotionDevices" : { "get" : { "description" : "Retrieve netmotionDevices related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[device_group]", "in" : "query", "description" : "Filter by device_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disconnect_reason]", "in" : "query", "description" : "Filter by disconnect_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_connect]", "in" : "query", "description" : "Filter by last_connect (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_user]", "in" : "query", "description" : "Filter by last_user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locality_version]", "in" : "query", "description" : "Filter by locality_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobility_version]", "in" : "query", "description" : "Filter by mobility_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[operating_system]", "in" : "query", "description" : "Filter by operating_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[registered]", "in" : "query", "description" : "Filter by registered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_disconnect]", "in" : "query", "description" : "Filter by last_disconnect (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_category]", "in" : "query", "description" : "Filter by asset_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/NetmotionDevicesFields" }, { "$ref" : "#/components/parameters/NetmotionDevicesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/NetmotionDevicesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/NetmotionDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/dist" : { "get" : { "description" : "Retrieve districts references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/deletionType" : { "get" : { "description" : "Retrieve deletionTypes references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/DeletionTypesFields" }, { "$ref" : "#/components/parameters/DeletionTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a deletionTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a deletionTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a deletionTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/repairReason" : { "get" : { "description" : "Retrieve repairReasons references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/RepairReasonsFields" }, { "$ref" : "#/components/parameters/RepairReasonsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a repairReasons resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a repairReasons resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a repairReasons resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RepairReasonsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/RepairReasonsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/locatorCheckins" : { "get" : { "description" : "Retrieve locatorCheckins references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[checkin_action]", "in" : "query", "description" : "Filter by checkin_action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_version]", "in" : "query", "description" : "Filter by asset_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_on]", "in" : "query", "description" : "Filter by reviewed_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsFields" }, { "$ref" : "#/components/parameters/LocatorCheckinsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/assetModel" : { "get" : { "description" : "Retrieve assetModels references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetModelsFields" }, { "$ref" : "#/components/parameters/AssetModelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/assetStatus" : { "get" : { "description" : "Retrieve assetStatuses references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetStatusesFields" }, { "$ref" : "#/components/parameters/AssetStatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a assetStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a assetStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a assetStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/categoryTypeMakeMapping" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/employeeAcceptedBy" : { "get" : { "description" : "Retrieve employees references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/assetAssignment" : { "get" : { "description" : "Retrieve assetAssignments references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/lastAssignment" : { "get" : { "description" : "Retrieve assetAssignments references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/location" : { "get" : { "description" : "Retrieve locations references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/assetAttributeValues" : { "get" : { "description" : "Retrieve assetAttributeValues references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[record_description]", "in" : "query", "description" : "Filter by record_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[update_process]", "in" : "query", "description" : "Filter by update_process (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesFields" }, { "$ref" : "#/components/parameters/AssetAttributeValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assets relationship to a assetAttributeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assets relationship to a assetAttributeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assets relationship to a assetAttributeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/netmotionDevices" : { "get" : { "description" : "Retrieve netmotionDevices references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[device_group]", "in" : "query", "description" : "Filter by device_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disconnect_reason]", "in" : "query", "description" : "Filter by disconnect_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_connect]", "in" : "query", "description" : "Filter by last_connect (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_user]", "in" : "query", "description" : "Filter by last_user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locality_version]", "in" : "query", "description" : "Filter by locality_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobility_version]", "in" : "query", "description" : "Filter by mobility_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[operating_system]", "in" : "query", "description" : "Filter by operating_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[registered]", "in" : "query", "description" : "Filter by registered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_disconnect]", "in" : "query", "description" : "Filter by last_disconnect (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_category]", "in" : "query", "description" : "Filter by asset_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/NetmotionDevicesFields" }, { "$ref" : "#/components/parameters/NetmotionDevicesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/NetmotionDevicesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/NetmotionDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assets/{id}/relationships/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups references related to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetsPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodeValues/{id}" : { "get" : { "description" : "Retrieve a quickCodeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeValuesFields" }, { "$ref" : "#/components/parameters/QuickCodeValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValuesResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a QuickCodeValues", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/QuickCodeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a QuickCodeValues", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValuesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuickCodeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodeValues" : { "get" : { "description" : "Retrieve a List of quickCodeValues resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesFields" }, { "$ref" : "#/components/parameters/QuickCodeValuesInclude" }, { "$ref" : "#/components/parameters/QuickCodeValuesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValuesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a QuickCodeValues", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValuesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuickCodeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodeValues/{id}/quickCode" : { "get" : { "description" : "Retrieve quickCodes related to a quickCodeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodesFields" }, { "$ref" : "#/components/parameters/QuickCodesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create quickCodeValues relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete quickCodeValues relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update quickCodeValues relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodeValues/{id}/relationships/quickCode" : { "get" : { "description" : "Retrieve quickCodes references related to a quickCodeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodesFields" }, { "$ref" : "#/components/parameters/QuickCodesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create quickCodeValues relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete quickCodeValues relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update quickCodeValues relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/notes/{id}" : { "get" : { "description" : "Retrieve a notes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NotesPrimaryKey" }, { "$ref" : "#/components/parameters/NotesFields" }, { "$ref" : "#/components/parameters/NotesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/NotesResourceResponse" }, "202" : { "$ref" : "#/components/responses/NotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Notes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NotesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/NotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Notes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NotesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NotesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/NotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/notes" : { "get" : { "description" : "Retrieve a List of notes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_kind]", "in" : "query", "description" : "Filter by entity_kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_id]", "in" : "query", "description" : "Filter by entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entered_by_id]", "in" : "query", "description" : "Filter by entered_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whenentered]", "in" : "query", "description" : "Filter by whenentered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whenposted]", "in" : "query", "description" : "Filter by whenposted (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type]", "in" : "query", "description" : "Filter by type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[note_text]", "in" : "query", "description" : "Filter by note_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_note]", "in" : "query", "description" : "Filter by excavator_note (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/NotesFields" }, { "$ref" : "#/components/parameters/NotesInclude" }, { "$ref" : "#/components/parameters/NotesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/NotesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/NotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Notes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NotesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NotesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/NotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}" : { "get" : { "description" : "Retrieve a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Activities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Activities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivitiesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities" : { "get" : { "description" : "Retrieve a List of activities resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" }, { "$ref" : "#/components/parameters/ActivitiesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Activities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivitiesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/locate" : { "get" : { "description" : "Retrieve locates related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/locateOpenSnapshot" : { "get" : { "description" : "Retrieve locateOpenSnapshots related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/locateClosedSnapshot" : { "get" : { "description" : "Retrieve locateClosedSnapshots related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/statusCode" : { "get" : { "description" : "Retrieve statusesCode related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/StatusesCodeFields" }, { "$ref" : "#/components/parameters/StatusesCodeInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesCodeResourceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/visit" : { "get" : { "description" : "Retrieve visits related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourceResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/firstClosingLocate" : { "get" : { "description" : "Retrieve locates related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/responseLogs" : { "get" : { "description" : "Retrieve responseLogs related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_sent]", "in" : "query", "description" : "Filter by when_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whenreplied]", "in" : "query", "description" : "Filter by whenreplied (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reply]", "in" : "query", "description" : "Filter by reply (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[success]", "in" : "query", "description" : "Filter by success (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[codesent]", "in" : "query", "description" : "Filter by codesent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq_number]", "in" : "query", "description" : "Filter by seq_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ResponseLogsFields" }, { "$ref" : "#/components/parameters/ResponseLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ResponseLogsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/activityPathPoints" : { "get" : { "description" : "Retrieve activityPathPoints related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[group_index]", "in" : "query", "description" : "Filter by group_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[order_index]", "in" : "query", "description" : "Filter by order_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_captured]", "in" : "query", "description" : "Filter by when_captured (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source]", "in" : "query", "description" : "Filter by source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[survey_id]", "in" : "query", "description" : "Filter by survey_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsFields" }, { "$ref" : "#/components/parameters/ActivityPathPointsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivityPathPointsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/relationships/locate" : { "get" : { "description" : "Retrieve locates references related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/relationships/locateOpenSnapshot" : { "get" : { "description" : "Retrieve locateOpenSnapshots references related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/relationships/locateClosedSnapshot" : { "get" : { "description" : "Retrieve locateClosedSnapshots references related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/relationships/statusCode" : { "get" : { "description" : "Retrieve statusesCode references related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/StatusesCodeFields" }, { "$ref" : "#/components/parameters/StatusesCodeInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesCodeResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/relationships/visit" : { "get" : { "description" : "Retrieve visits references related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/relationships/firstClosingLocate" : { "get" : { "description" : "Retrieve locates references related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/relationships/responseLogs" : { "get" : { "description" : "Retrieve responseLogs references related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_sent]", "in" : "query", "description" : "Filter by when_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whenreplied]", "in" : "query", "description" : "Filter by whenreplied (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reply]", "in" : "query", "description" : "Filter by reply (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[success]", "in" : "query", "description" : "Filter by success (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[codesent]", "in" : "query", "description" : "Filter by codesent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq_number]", "in" : "query", "description" : "Filter by seq_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ResponseLogsFields" }, { "$ref" : "#/components/parameters/ResponseLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/activities/{id}/relationships/activityPathPoints" : { "get" : { "description" : "Retrieve activityPathPoints references related to a activities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ActivitiesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[group_index]", "in" : "query", "description" : "Filter by group_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[order_index]", "in" : "query", "description" : "Filter by order_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_captured]", "in" : "query", "description" : "Filter by when_captured (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source]", "in" : "query", "description" : "Filter by source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[survey_id]", "in" : "query", "description" : "Filter by survey_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivityPathPointsFields" }, { "$ref" : "#/components/parameters/ActivityPathPointsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ActivityPathPointsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}" : { "get" : { "description" : "Retrieve a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TransmissionsBase", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TransmissionsBase", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsBasePatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase" : { "get" : { "description" : "Retrieve a List of transmissionsBase resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_type]", "in" : "query", "description" : "Filter by message_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trans_number]", "in" : "query", "description" : "Filter by trans_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[after_hours]", "in" : "query", "description" : "Filter by after_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet]", "in" : "query", "description" : "Filter by meet (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_date]", "in" : "query", "description" : "Filter by meet_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_code]", "in" : "query", "description" : "Filter by meet_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmitted_legal_due_date]", "in" : "query", "description" : "Filter by transmitted_legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_type]", "in" : "query", "description" : "Filter by transmission_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_area_code]", "in" : "query", "description" : "Filter by service_area_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_code]", "in" : "query", "description" : "Filter by master_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_code]", "in" : "query", "description" : "Filter by billing_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[download_time]", "in" : "query", "description" : "Filter by download_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subdivision]", "in" : "query", "description" : "Filter by subdivision (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_dir]", "in" : "query", "description" : "Filter by street_dir (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lead_time]", "in" : "query", "description" : "Filter by lead_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[blasting]", "in" : "query", "description" : "Filter by blasting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickets]", "in" : "query", "description" : "Filter by tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" }, { "$ref" : "#/components/parameters/TransmissionsBaseSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TransmissionsBase", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsBasePostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/transmissionExtra" : { "get" : { "description" : "Retrieve transmissionExtras related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/locates" : { "get" : { "description" : "Retrieve locates related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/tickets" : { "get" : { "description" : "Retrieve tickets related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticketsInfo]", "in" : "query", "description" : "Filter by ticketsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachments]", "in" : "query", "description" : "Filter by tkpAttachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentsCategorized]", "in" : "query", "description" : "Filter by attachmentsCategorized (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachmentsWithNotifications]", "in" : "query", "description" : "Filter by tkpAttachmentsWithNotifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkedTickets]", "in" : "query", "description" : "Filter by linkedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/cpClosedTickets" : { "get" : { "description" : "Retrieve ticketCloseds related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketClosedsFields" }, { "$ref" : "#/components/parameters/TicketClosedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketClosedsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/responseLogs" : { "get" : { "description" : "Retrieve responseLogs related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_sent]", "in" : "query", "description" : "Filter by when_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whenreplied]", "in" : "query", "description" : "Filter by whenreplied (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reply]", "in" : "query", "description" : "Filter by reply (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[success]", "in" : "query", "description" : "Filter by success (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[codesent]", "in" : "query", "description" : "Filter by codesent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq_number]", "in" : "query", "description" : "Filter by seq_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ResponseLogsFields" }, { "$ref" : "#/components/parameters/ResponseLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ResponseLogsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/feed" : { "get" : { "description" : "Retrieve feeds related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/relationships/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail references related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/relationships/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText references related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/relationships/transmissionExtra" : { "get" : { "description" : "Retrieve transmissionExtras references related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/relationships/locates" : { "get" : { "description" : "Retrieve locates references related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/relationships/tickets" : { "get" : { "description" : "Retrieve tickets references related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticketsInfo]", "in" : "query", "description" : "Filter by ticketsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachments]", "in" : "query", "description" : "Filter by tkpAttachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentsCategorized]", "in" : "query", "description" : "Filter by attachmentsCategorized (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachmentsWithNotifications]", "in" : "query", "description" : "Filter by tkpAttachmentsWithNotifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkedTickets]", "in" : "query", "description" : "Filter by linkedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/relationships/cpClosedTickets" : { "get" : { "description" : "Retrieve ticketCloseds references related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketClosedsFields" }, { "$ref" : "#/components/parameters/TicketClosedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/relationships/responseLogs" : { "get" : { "description" : "Retrieve responseLogs references related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_sent]", "in" : "query", "description" : "Filter by when_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whenreplied]", "in" : "query", "description" : "Filter by whenreplied (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reply]", "in" : "query", "description" : "Filter by reply (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[success]", "in" : "query", "description" : "Filter by success (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[codesent]", "in" : "query", "description" : "Filter by codesent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq_number]", "in" : "query", "description" : "Filter by seq_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity]", "in" : "query", "description" : "Filter by activity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ResponseLogsFields" }, { "$ref" : "#/components/parameters/ResponseLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ResponseLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsBase/{id}/relationships/feed" : { "get" : { "description" : "Retrieve feeds references related to a transmissionsBase resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsBasePrimaryKey" }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}" : { "get" : { "description" : "Retrieve a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CategoryTypeMakeMappings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CategoryTypeMakeMappings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings" : { "get" : { "description" : "Retrieve a List of categoryTypeMakeMappings resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_id]", "in" : "query", "description" : "Filter by type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_type_id]", "in" : "query", "description" : "Filter by category_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategory]", "in" : "query", "description" : "Filter by assetCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategoryType]", "in" : "query", "description" : "Filter by assetCategoryType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CategoryTypeMakeMappings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assetCategory" : { "get" : { "description" : "Retrieve assetCategories related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetCategoriesFields" }, { "$ref" : "#/components/parameters/AssetCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create categoryTypeMakeMappings relationship to a assetCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete categoryTypeMakeMappings relationship to a assetCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update categoryTypeMakeMappings relationship to a assetCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assetType" : { "get" : { "description" : "Retrieve assetTypes related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetTypesFields" }, { "$ref" : "#/components/parameters/AssetTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create categoryTypeMakeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete categoryTypeMakeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update categoryTypeMakeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assetMake" : { "get" : { "description" : "Retrieve assetMakes related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetMakesFields" }, { "$ref" : "#/components/parameters/AssetMakesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create categoryTypeMakeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete categoryTypeMakeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update categoryTypeMakeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assetCategoryType" : { "get" : { "description" : "Retrieve assetCategoryTypes related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetCategoryTypesFields" }, { "$ref" : "#/components/parameters/AssetCategoryTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create categoryTypeMakeMappings relationship to a assetCategoryTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete categoryTypeMakeMappings relationship to a assetCategoryTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update categoryTypeMakeMappings relationship to a assetCategoryTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assets" : { "get" : { "description" : "Retrieve assets related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assetCategory" : { "get" : { "description" : "Retrieve assetCategories references related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetCategoriesFields" }, { "$ref" : "#/components/parameters/AssetCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create categoryTypeMakeMappings relationship to a assetCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete categoryTypeMakeMappings relationship to a assetCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update categoryTypeMakeMappings relationship to a assetCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assetType" : { "get" : { "description" : "Retrieve assetTypes references related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetTypesFields" }, { "$ref" : "#/components/parameters/AssetTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create categoryTypeMakeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete categoryTypeMakeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update categoryTypeMakeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assetMake" : { "get" : { "description" : "Retrieve assetMakes references related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetMakesFields" }, { "$ref" : "#/components/parameters/AssetMakesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create categoryTypeMakeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete categoryTypeMakeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update categoryTypeMakeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assetCategoryType" : { "get" : { "description" : "Retrieve assetCategoryTypes references related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetCategoryTypesFields" }, { "$ref" : "#/components/parameters/AssetCategoryTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create categoryTypeMakeMappings relationship to a assetCategoryTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete categoryTypeMakeMappings relationship to a assetCategoryTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update categoryTypeMakeMappings relationship to a assetCategoryTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetCategoryTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assets" : { "get" : { "description" : "Retrieve assets references related to a categoryTypeMakeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/applications/{id}" : { "get" : { "description" : "Retrieve a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" }, { "$ref" : "#/components/parameters/ApplicationsFields" }, { "$ref" : "#/components/parameters/ApplicationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Applications", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Applications", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/applications" : { "get" : { "description" : "Retrieve a List of applications resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[url]", "in" : "query", "description" : "Filter by url (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentEntities]", "in" : "query", "description" : "Filter by attachmentEntities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[storageVolumes]", "in" : "query", "description" : "Filter by storageVolumes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userDataAccesses]", "in" : "query", "description" : "Filter by userDataAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ApplicationsFields" }, { "$ref" : "#/components/parameters/ApplicationsInclude" }, { "$ref" : "#/components/parameters/ApplicationsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Applications", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/applications/{id}/attachmentEntities" : { "get" : { "description" : "Retrieve attachmentEntities related to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_name]", "in" : "query", "description" : "Filter by attachment_entity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_table]", "in" : "query", "description" : "Filter by entity_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachments]", "in" : "query", "description" : "Filter by attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesFields" }, { "$ref" : "#/components/parameters/AttachmentEntitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/applications/{id}/storageVolumes" : { "get" : { "description" : "Retrieve storageVolumes related to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[protocol]", "in" : "query", "description" : "Filter by protocol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachments]", "in" : "query", "description" : "Filter by attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/StorageVolumesFields" }, { "$ref" : "#/components/parameters/StorageVolumesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/applications/{id}/userDataAccesses" : { "get" : { "description" : "Retrieve userDataAccesses related to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_districts]", "in" : "query", "description" : "Filter by all_districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_supgroups]", "in" : "query", "description" : "Filter by all_supgroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesFields" }, { "$ref" : "#/components/parameters/UserDataAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create applications relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete applications relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update applications relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/applications/{id}/relationships/attachmentEntities" : { "get" : { "description" : "Retrieve attachmentEntities references related to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_name]", "in" : "query", "description" : "Filter by attachment_entity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_table]", "in" : "query", "description" : "Filter by entity_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachments]", "in" : "query", "description" : "Filter by attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentEntitiesFields" }, { "$ref" : "#/components/parameters/AttachmentEntitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/applications/{id}/relationships/storageVolumes" : { "get" : { "description" : "Retrieve storageVolumes references related to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[protocol]", "in" : "query", "description" : "Filter by protocol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachments]", "in" : "query", "description" : "Filter by attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/StorageVolumesFields" }, { "$ref" : "#/components/parameters/StorageVolumesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/applications/{id}/relationships/userDataAccesses" : { "get" : { "description" : "Retrieve userDataAccesses references related to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_districts]", "in" : "query", "description" : "Filter by all_districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_supgroups]", "in" : "query", "description" : "Filter by all_supgroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesFields" }, { "$ref" : "#/components/parameters/UserDataAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create applications relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete applications relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update applications relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ApplicationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}" : { "get" : { "description" : "Retrieve a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a PolicyDropOffEstimates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a PolicyDropOffEstimates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates" : { "get" : { "description" : "Retrieve a List of policyDropOffEstimates resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a PolicyDropOffEstimates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/investigationDetail" : { "get" : { "description" : "Retrieve investigationDetails related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/wfNotification" : { "get" : { "description" : "Retrieve wfNotifications related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/WfNotificationsFields" }, { "$ref" : "#/components/parameters/WfNotificationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/quickCValue" : { "get" : { "description" : "Retrieve quickCodeValue related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/district" : { "get" : { "description" : "Retrieve districts related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/relationships/investigationDetail" : { "get" : { "description" : "Retrieve investigationDetails references related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/relationships/wfNotification" : { "get" : { "description" : "Retrieve wfNotifications references related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/WfNotificationsFields" }, { "$ref" : "#/components/parameters/WfNotificationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/relationships/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods references related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/relationships/quickCValue" : { "get" : { "description" : "Retrieve quickCodeValue references related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/relationships/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests references related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/policyDropOffEstimates/{id}/relationships/district" : { "get" : { "description" : "Retrieve districts references related to a policyDropOffEstimates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetModels/{id}" : { "get" : { "description" : "Retrieve a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetModelsFields" }, { "$ref" : "#/components/parameters/AssetModelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetModels", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetModels", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetModels" : { "get" : { "description" : "Retrieve a List of assetModels resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetModelsFields" }, { "$ref" : "#/components/parameters/AssetModelsInclude" }, { "$ref" : "#/components/parameters/AssetModelsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetModels", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetModels/{id}/assets" : { "get" : { "description" : "Retrieve assets related to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetModels/{id}/assetMake" : { "get" : { "description" : "Retrieve assetMakes related to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetMakesFields" }, { "$ref" : "#/components/parameters/AssetMakesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetModels relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetModels relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetModels relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetModels/{id}/relationships/assets" : { "get" : { "description" : "Retrieve assets references related to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetModels/{id}/relationships/assetMake" : { "get" : { "description" : "Retrieve assetMakes references related to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetMakesFields" }, { "$ref" : "#/components/parameters/AssetMakesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetModels relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetModels relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetModels relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetModelsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountLocateMatches/{id}" : { "get" : { "description" : "Retrieve a serviceAccountLocateMatches resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesPrimaryKey" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesFields" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ServiceAccountLocateMatches", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ServiceAccountLocateMatches", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountLocateMatches" : { "get" : { "description" : "Retrieve a List of serviceAccountLocateMatches resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_customer_id]", "in" : "query", "description" : "Filter by service_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_expire_date]", "in" : "query", "description" : "Filter by service_expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_name]", "in" : "query", "description" : "Filter by service_contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_email]", "in" : "query", "description" : "Filter by service_contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_billing_type]", "in" : "query", "description" : "Filter by service_billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_feed_email]", "in" : "query", "description" : "Filter by service_feed_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_bore_footage]", "in" : "query", "description" : "Filter by service_bore_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpTicket]", "in" : "query", "description" : "Filter by tkpTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesFields" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesInclude" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ServiceAccountLocateMatches", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/tkpServiceCustomer" : { "get" : { "description" : "Retrieve tkpcustomers related to a serviceAccountLocateMatches resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesPrimaryKey" }, { "$ref" : "#/components/parameters/TkpcustomersFields" }, { "$ref" : "#/components/parameters/TkpcustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpcustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpcustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/serviceAccount" : { "get" : { "description" : "Retrieve serviceAccounts related to a serviceAccountLocateMatches resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesPrimaryKey" }, { "$ref" : "#/components/parameters/ServiceAccountsFields" }, { "$ref" : "#/components/parameters/ServiceAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/tkpTicket" : { "get" : { "description" : "Retrieve tkpTickets related to a serviceAccountLocateMatches resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesPrimaryKey" }, { "$ref" : "#/components/parameters/TkpTicketsFields" }, { "$ref" : "#/components/parameters/TkpTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpTicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/relationships/tkpServiceCustomer" : { "get" : { "description" : "Retrieve tkpcustomers references related to a serviceAccountLocateMatches resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesPrimaryKey" }, { "$ref" : "#/components/parameters/TkpcustomersFields" }, { "$ref" : "#/components/parameters/TkpcustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpcustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TkpcustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/relationships/serviceAccount" : { "get" : { "description" : "Retrieve serviceAccounts references related to a serviceAccountLocateMatches resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesPrimaryKey" }, { "$ref" : "#/components/parameters/ServiceAccountsFields" }, { "$ref" : "#/components/parameters/ServiceAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/relationships/tkpTicket" : { "get" : { "description" : "Retrieve tkpTickets references related to a serviceAccountLocateMatches resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesPrimaryKey" }, { "$ref" : "#/components/parameters/TkpTicketsFields" }, { "$ref" : "#/components/parameters/TkpTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpTicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TkpTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/randomEmployeePicks/{id}" : { "get" : { "description" : "Retrieve a randomEmployeePicks resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RandomEmployeePicksPrimaryKey" }, { "$ref" : "#/components/parameters/RandomEmployeePicksFields" }, { "$ref" : "#/components/parameters/RandomEmployeePicksInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RandomEmployeePicksResourceResponse" }, "202" : { "$ref" : "#/components/responses/RandomEmployeePicksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a RandomEmployeePicks", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RandomEmployeePicksPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/RandomEmployeePicksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a RandomEmployeePicks", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RandomEmployeePicksPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RandomEmployeePicksPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RandomEmployeePicksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/randomEmployeePicks" : { "get" : { "description" : "Retrieve a List of randomEmployeePicks resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pick_date]", "in" : "query", "description" : "Filter by pick_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RandomEmployeePicksFields" }, { "$ref" : "#/components/parameters/RandomEmployeePicksInclude" }, { "$ref" : "#/components/parameters/RandomEmployeePicksSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RandomEmployeePicksResourcesResponse" }, "202" : { "$ref" : "#/components/responses/RandomEmployeePicksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a RandomEmployeePicks", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RandomEmployeePicksPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RandomEmployeePicksResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RandomEmployeePicksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}" : { "get" : { "description" : "Retrieve a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a SupervisorGroups", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a SupervisorGroups", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups" : { "get" : { "description" : "Retrieve a List of supervisorGroups resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_code]", "in" : "query", "description" : "Filter by district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_name]", "in" : "query", "description" : "Filter by district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employees]", "in" : "query", "description" : "Filter by employees (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesOnLoan]", "in" : "query", "description" : "Filter by employeesOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" }, { "$ref" : "#/components/parameters/SupervisorGroupsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a SupervisorGroups", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/dist" : { "get" : { "description" : "Retrieve districts related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/employees" : { "get" : { "description" : "Retrieve employees related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action]", "in" : "query", "description" : "Filter by action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimated_return_date]", "in" : "query", "description" : "Filter by estimated_return_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[announcements]", "in" : "query", "description" : "Filter by announcements (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignments]", "in" : "query", "description" : "Filter by assignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[requests]", "in" : "query", "description" : "Filter by requests (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acceptedAssets]", "in" : "query", "description" : "Filter by acceptedAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userDataAccesses]", "in" : "query", "description" : "Filter by userDataAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deviceTokens]", "in" : "query", "description" : "Filter by deviceTokens (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeMessages]", "in" : "query", "description" : "Filter by employeeMessages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messages]", "in" : "query", "description" : "Filter by messages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobsInfo]", "in" : "query", "description" : "Filter by schedulerJobsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigations]", "in" : "query", "description" : "Filter by investigations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[comments]", "in" : "query", "description" : "Filter by comments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ideas]", "in" : "query", "description" : "Filter by ideas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/employeesOnLoan" : { "get" : { "description" : "Retrieve employeesOnLoan related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/employeesActiveNoAsset" : { "get" : { "description" : "Retrieve employeesActiveNoAssets related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/assets" : { "get" : { "description" : "Retrieve assets related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/relationships/dist" : { "get" : { "description" : "Retrieve districts references related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/relationships/employees" : { "get" : { "description" : "Retrieve employees references related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action]", "in" : "query", "description" : "Filter by action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimated_return_date]", "in" : "query", "description" : "Filter by estimated_return_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[announcements]", "in" : "query", "description" : "Filter by announcements (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignments]", "in" : "query", "description" : "Filter by assignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[requests]", "in" : "query", "description" : "Filter by requests (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acceptedAssets]", "in" : "query", "description" : "Filter by acceptedAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userDataAccesses]", "in" : "query", "description" : "Filter by userDataAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deviceTokens]", "in" : "query", "description" : "Filter by deviceTokens (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeMessages]", "in" : "query", "description" : "Filter by employeeMessages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messages]", "in" : "query", "description" : "Filter by messages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobsInfo]", "in" : "query", "description" : "Filter by schedulerJobsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigations]", "in" : "query", "description" : "Filter by investigations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[comments]", "in" : "query", "description" : "Filter by comments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ideas]", "in" : "query", "description" : "Filter by ideas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/relationships/employeesOnLoan" : { "get" : { "description" : "Retrieve employeesOnLoan references related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/relationships/employeesActiveNoAsset" : { "get" : { "description" : "Retrieve employeesActiveNoAssets references related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/supervisorGroups/{id}/relationships/assets" : { "get" : { "description" : "Retrieve assets references related to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/termUtilityMaps/{id}" : { "get" : { "description" : "Retrieve a termUtilityMaps resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsPrimaryKey" }, { "$ref" : "#/components/parameters/TermUtilityMapsFields" }, { "$ref" : "#/components/parameters/TermUtilityMapsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermUtilityMapsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TermUtilityMaps", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TermUtilityMaps", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermUtilityMapsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/termUtilityMaps" : { "get" : { "description" : "Retrieve a List of termUtilityMaps resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsFields" }, { "$ref" : "#/components/parameters/TermUtilityMapsInclude" }, { "$ref" : "#/components/parameters/TermUtilityMapsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermUtilityMapsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TermUtilityMaps", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermUtilityMapsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/termUtilityMaps/{id}/locate" : { "get" : { "description" : "Retrieve locates related to a termUtilityMaps resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsPrimaryKey" }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/termUtilityMaps/{id}/locateOpenSnapshot" : { "get" : { "description" : "Retrieve locateOpenSnapshots related to a termUtilityMaps resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsPrimaryKey" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/termUtilityMaps/{id}/locateClosedSnapshot" : { "get" : { "description" : "Retrieve locateClosedSnapshots related to a termUtilityMaps resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsPrimaryKey" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/termUtilityMaps/{id}/relationships/locate" : { "get" : { "description" : "Retrieve locates references related to a termUtilityMaps resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsPrimaryKey" }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/termUtilityMaps/{id}/relationships/locateOpenSnapshot" : { "get" : { "description" : "Retrieve locateOpenSnapshots references related to a termUtilityMaps resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsPrimaryKey" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/termUtilityMaps/{id}/relationships/locateClosedSnapshot" : { "get" : { "description" : "Retrieve locateClosedSnapshots references related to a termUtilityMaps resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermUtilityMapsPrimaryKey" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobs/{id}" : { "get" : { "description" : "Retrieve a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" }, { "$ref" : "#/components/parameters/SchedulerJobsFields" }, { "$ref" : "#/components/parameters/SchedulerJobsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a SchedulerJobs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a SchedulerJobs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobs" : { "get" : { "description" : "Retrieve a List of schedulerJobs resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_group]", "in" : "query", "description" : "Filter by job_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_class]", "in" : "query", "description" : "Filter by job_class (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_expression]", "in" : "query", "description" : "Filter by cron_expression (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repeat_time]", "in" : "query", "description" : "Filter by repeat_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_job]", "in" : "query", "description" : "Filter by cron_job (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[time_zone]", "in" : "query", "description" : "Filter by time_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parameters]", "in" : "query", "description" : "Filter by parameters (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[jobInfo]", "in" : "query", "description" : "Filter by jobInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobStatus]", "in" : "query", "description" : "Filter by schedulerJobStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsFields" }, { "$ref" : "#/components/parameters/SchedulerJobsInclude" }, { "$ref" : "#/components/parameters/SchedulerJobsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a SchedulerJobs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobs/{id}/schedulerJobStatus" : { "get" : { "description" : "Retrieve schedulerJobStatuses related to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" }, { "$ref" : "#/components/parameters/SchedulerJobStatusesFields" }, { "$ref" : "#/components/parameters/SchedulerJobStatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create schedulerJobs relationship to a schedulerJobStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete schedulerJobs relationship to a schedulerJobStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update schedulerJobs relationship to a schedulerJobStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobs/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobs/{id}/relationships/schedulerJobStatus" : { "get" : { "description" : "Retrieve schedulerJobStatuses references related to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" }, { "$ref" : "#/components/parameters/SchedulerJobStatusesFields" }, { "$ref" : "#/components/parameters/SchedulerJobStatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create schedulerJobs relationship to a schedulerJobStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete schedulerJobs relationship to a schedulerJobStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update schedulerJobs relationship to a schedulerJobStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/schedulerJobs/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users/{id}" : { "get" : { "description" : "Retrieve a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" }, { "$ref" : "#/components/parameters/UsersFields" }, { "$ref" : "#/components/parameters/UsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Users", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Users", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users" : { "get" : { "description" : "Retrieve a List of users resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_name]", "in" : "query", "description" : "Filter by cp_user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_name]", "in" : "query", "description" : "Filter by first_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_name]", "in" : "query", "description" : "Filter by last_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[middle_name]", "in" : "query", "description" : "Filter by middle_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[preferred_name]", "in" : "query", "description" : "Filter by preferred_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email_address]", "in" : "query", "description" : "Filter by email_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_admin]", "in" : "query", "description" : "Filter by cp_admin (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile_phone]", "in" : "query", "description" : "Filter by mobile_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[receive_notifications]", "in" : "query", "description" : "Filter by receive_notifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_logged_on]", "in" : "query", "description" : "Filter by last_logged_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[logo_id]", "in" : "query", "description" : "Filter by logo_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_tickets]", "in" : "query", "description" : "Filter by show_tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_damages]", "in" : "query", "description" : "Filter by show_damages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_managed_services]", "in" : "query", "description" : "Filter by show_managed_services (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_date]", "in" : "query", "description" : "Filter by password_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[nda_signed]", "in" : "query", "description" : "Filter by nda_signed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_history]", "in" : "query", "description" : "Filter by show_history (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_responses]", "in" : "query", "description" : "Filter by show_responses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_screenshots]", "in" : "query", "description" : "Filter by show_screenshots (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[show_gps]", "in" : "query", "description" : "Filter by show_gps (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expiration_cycle]", "in" : "query", "description" : "Filter by expiration_cycle (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_gps]", "in" : "query", "description" : "Filter by export_gps (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachments_with_notifications]", "in" : "query", "description" : "Filter by attachments_with_notifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[managed_services]", "in" : "query", "description" : "Filter by managed_services (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ms_admin]", "in" : "query", "description" : "Filter by ms_admin (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_admin]", "in" : "query", "description" : "Filter by account_admin (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_domains]", "in" : "query", "description" : "Filter by account_domains (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[allow_exports]", "in" : "query", "description" : "Filter by allow_exports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sessions]", "in" : "query", "description" : "Filter by sessions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccounts]", "in" : "query", "description" : "Filter by customerAccounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContracts]", "in" : "query", "description" : "Filter by customerContracts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UsersFields" }, { "$ref" : "#/components/parameters/UsersInclude" }, { "$ref" : "#/components/parameters/UsersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Users", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users/{id}/sessions" : { "get" : { "description" : "Retrieve sessions related to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[event]", "in" : "query", "description" : "Filter by event (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[event_time]", "in" : "query", "description" : "Filter by event_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SessionsFields" }, { "$ref" : "#/components/parameters/SessionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create users relationship to a sessions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete users relationship to a sessions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update users relationship to a sessions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users/{id}/userAccesses" : { "get" : { "description" : "Retrieve userAccesses related to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_states]", "in" : "query", "description" : "Filter by customer_states (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccessesFields" }, { "$ref" : "#/components/parameters/UserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create users relationship to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete users relationship to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update users relationship to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users/{id}/customerAccounts" : { "get" : { "description" : "Retrieve customerAccounts related to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parent_account_number]", "in" : "query", "description" : "Filter by parent_account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_name]", "in" : "query", "description" : "Filter by account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[alt_name]", "in" : "query", "description" : "Filter by alt_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_status]", "in" : "query", "description" : "Filter by item_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContracts]", "in" : "query", "description" : "Filter by customerContracts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccountNotes]", "in" : "query", "description" : "Filter by customerAccountNotes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContractSettings]", "in" : "query", "description" : "Filter by customerContractSettings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccountContractAccess]", "in" : "query", "description" : "Filter by userAccountContractAccess (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create users relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete users relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update users relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users/{id}/customerContracts" : { "get" : { "description" : "Retrieve customerContracts related to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_status]", "in" : "query", "description" : "Filter by item_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccountContractAccesses]", "in" : "query", "description" : "Filter by userAccountContractAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContractSetting]", "in" : "query", "description" : "Filter by customerContractSetting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create users relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete users relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update users relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users/{id}/relationships/sessions" : { "get" : { "description" : "Retrieve sessions references related to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[event]", "in" : "query", "description" : "Filter by event (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[event_time]", "in" : "query", "description" : "Filter by event_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SessionsFields" }, { "$ref" : "#/components/parameters/SessionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create users relationship to a sessions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete users relationship to a sessions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update users relationship to a sessions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users/{id}/relationships/userAccesses" : { "get" : { "description" : "Retrieve userAccesses references related to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_states]", "in" : "query", "description" : "Filter by customer_states (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccessesFields" }, { "$ref" : "#/components/parameters/UserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create users relationship to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete users relationship to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update users relationship to a userAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users/{id}/relationships/customerAccounts" : { "get" : { "description" : "Retrieve customerAccounts references related to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parent_account_number]", "in" : "query", "description" : "Filter by parent_account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_name]", "in" : "query", "description" : "Filter by account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[alt_name]", "in" : "query", "description" : "Filter by alt_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_status]", "in" : "query", "description" : "Filter by item_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContracts]", "in" : "query", "description" : "Filter by customerContracts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccountNotes]", "in" : "query", "description" : "Filter by customerAccountNotes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContractSettings]", "in" : "query", "description" : "Filter by customerContractSettings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccountContractAccess]", "in" : "query", "description" : "Filter by userAccountContractAccess (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create users relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete users relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update users relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/users/{id}/relationships/customerContracts" : { "get" : { "description" : "Retrieve customerContracts references related to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_status]", "in" : "query", "description" : "Filter by item_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccountContractAccesses]", "in" : "query", "description" : "Filter by userAccountContractAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContractSetting]", "in" : "query", "description" : "Filter by customerContractSetting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create users relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete users relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update users relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/closedTicket/{id}" : { "get" : { "description" : "Retrieve a closedTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClosedTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/ClosedTicketsFields" }, { "$ref" : "#/components/parameters/ClosedTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClosedTicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClosedTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ClosedTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClosedTicketsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ClosedTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ClosedTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClosedTicketsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClosedTicketsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClosedTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/closedTicket" : { "get" : { "description" : "Retrieve a List of closedTickets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count]", "in" : "query", "description" : "Filter by count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClosedTicketsFields" }, { "$ref" : "#/components/parameters/ClosedTicketsInclude" }, { "$ref" : "#/components/parameters/ClosedTicketsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClosedTicketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClosedTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ClosedTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClosedTicketsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClosedTicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClosedTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/buckets/{id}" : { "get" : { "description" : "Retrieve a buckets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BucketsPrimaryKey" }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Buckets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BucketsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Buckets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BucketsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BucketsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/buckets" : { "get" : { "description" : "Retrieve a List of buckets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[screening]", "in" : "query", "description" : "Filter by screening (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[translore]", "in" : "query", "description" : "Filter by translore (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" }, { "$ref" : "#/components/parameters/BucketsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Buckets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BucketsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BucketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/buckets/{id}/locates" : { "get" : { "description" : "Retrieve locates related to a buckets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BucketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/buckets/{id}/usr" : { "get" : { "description" : "Retrieve usrs related to a buckets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BucketsPrimaryKey" }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/buckets/{id}/relationships/locates" : { "get" : { "description" : "Retrieve locates references related to a buckets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BucketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/buckets/{id}/relationships/usr" : { "get" : { "description" : "Retrieve usrs references related to a buckets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/BucketsPrimaryKey" }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles/{id}" : { "get" : { "description" : "Retrieve a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Vehicles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Vehicles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles" : { "get" : { "description" : "Retrieve a List of vehicles resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cvn]", "in" : "query", "description" : "Filter by cvn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_year]", "in" : "query", "description" : "Filter by model_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make]", "in" : "query", "description" : "Filter by make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_group]", "in" : "query", "description" : "Filter by model_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vin_number]", "in" : "query", "description" : "Filter by vin_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[license_plate_number]", "in" : "query", "description" : "Filter by license_plate_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" }, { "$ref" : "#/components/parameters/VehiclesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Vehicles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles/{id}/employeeOnLoan" : { "get" : { "description" : "Retrieve employeesOnLoan related to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create vehicles relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete vehicles relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update vehicles relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles/{id}/employeesActiveMultipleItAssets" : { "get" : { "description" : "Retrieve employeesActiveMultipleItAssets related to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles/{id}/employeesActiveNoAsset" : { "get" : { "description" : "Retrieve employeesActiveNoAssets related to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles/{id}/relationships/employeeOnLoan" : { "get" : { "description" : "Retrieve employeesOnLoan references related to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create vehicles relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete vehicles relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update vehicles relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles/{id}/relationships/employeesActiveMultipleItAssets" : { "get" : { "description" : "Retrieve employeesActiveMultipleItAssets references related to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/vehicles/{id}/relationships/employeesActiveNoAsset" : { "get" : { "description" : "Retrieve employeesActiveNoAssets references related to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VehiclesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccounts/{id}" : { "get" : { "description" : "Retrieve a serviceAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/ServiceAccountsFields" }, { "$ref" : "#/components/parameters/ServiceAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ServiceAccounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ServiceAccounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccounts" : { "get" : { "description" : "Retrieve a List of serviceAccounts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deleted]", "in" : "query", "description" : "Filter by deleted (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[modified_date]", "in" : "query", "description" : "Filter by modified_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expire_date]", "in" : "query", "description" : "Filter by expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_email]", "in" : "query", "description" : "Filter by contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_type]", "in" : "query", "description" : "Filter by billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccountRules]", "in" : "query", "description" : "Filter by serviceAccountRules (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccountLocateMatches]", "in" : "query", "description" : "Filter by serviceAccountLocateMatches (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsFields" }, { "$ref" : "#/components/parameters/ServiceAccountsInclude" }, { "$ref" : "#/components/parameters/ServiceAccountsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ServiceAccounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccounts/{id}/serviceAccountRules" : { "get" : { "description" : "Retrieve serviceAccountRules related to a serviceAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_include]", "in" : "query", "description" : "Filter by excavator_include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_exclude]", "in" : "query", "description" : "Filter by excavator_exclude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for_include]", "in" : "query", "description" : "Filter by work_done_for_include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for_exclude]", "in" : "query", "description" : "Filter by work_done_for_exclude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[external]", "in" : "query", "description" : "Filter by external (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deleted]", "in" : "query", "description" : "Filter by deleted (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[modified_date]", "in" : "query", "description" : "Filter by modified_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by_user_id]", "in" : "query", "description" : "Filter by created_by_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_type]", "in" : "query", "description" : "Filter by work_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountRulesFields" }, { "$ref" : "#/components/parameters/ServiceAccountRulesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountRulesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountRulesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccounts/{id}/serviceAccountLocateMatches" : { "get" : { "description" : "Retrieve serviceAccountLocateMatches related to a serviceAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_customer_id]", "in" : "query", "description" : "Filter by service_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_expire_date]", "in" : "query", "description" : "Filter by service_expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_name]", "in" : "query", "description" : "Filter by service_contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_email]", "in" : "query", "description" : "Filter by service_contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_billing_type]", "in" : "query", "description" : "Filter by service_billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_feed_email]", "in" : "query", "description" : "Filter by service_feed_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_bore_footage]", "in" : "query", "description" : "Filter by service_bore_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpTicket]", "in" : "query", "description" : "Filter by tkpTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesFields" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccounts/{id}/tkpServiceCustomer" : { "get" : { "description" : "Retrieve tkpcustomers related to a serviceAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpcustomersFields" }, { "$ref" : "#/components/parameters/TkpcustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpcustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpcustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccounts/{id}/relationships/serviceAccountRules" : { "get" : { "description" : "Retrieve serviceAccountRules references related to a serviceAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_include]", "in" : "query", "description" : "Filter by excavator_include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_exclude]", "in" : "query", "description" : "Filter by excavator_exclude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for_include]", "in" : "query", "description" : "Filter by work_done_for_include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for_exclude]", "in" : "query", "description" : "Filter by work_done_for_exclude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[external]", "in" : "query", "description" : "Filter by external (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deleted]", "in" : "query", "description" : "Filter by deleted (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[modified_date]", "in" : "query", "description" : "Filter by modified_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by_user_id]", "in" : "query", "description" : "Filter by created_by_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_type]", "in" : "query", "description" : "Filter by work_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountRulesFields" }, { "$ref" : "#/components/parameters/ServiceAccountRulesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountRulesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountRulesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccounts/{id}/relationships/serviceAccountLocateMatches" : { "get" : { "description" : "Retrieve serviceAccountLocateMatches references related to a serviceAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_customer_id]", "in" : "query", "description" : "Filter by service_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_expire_date]", "in" : "query", "description" : "Filter by service_expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_name]", "in" : "query", "description" : "Filter by service_contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_email]", "in" : "query", "description" : "Filter by service_contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_billing_type]", "in" : "query", "description" : "Filter by service_billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_feed_email]", "in" : "query", "description" : "Filter by service_feed_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_bore_footage]", "in" : "query", "description" : "Filter by service_bore_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpTicket]", "in" : "query", "description" : "Filter by tkpTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesFields" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccounts/{id}/relationships/tkpServiceCustomer" : { "get" : { "description" : "Retrieve tkpcustomers references related to a serviceAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpcustomersFields" }, { "$ref" : "#/components/parameters/TkpcustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpcustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TkpcustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/userRoleAssignments/{id}" : { "get" : { "description" : "Retrieve a userRoleAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRoleAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/UserRoleAssignmentsFields" }, { "$ref" : "#/components/parameters/UserRoleAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRoleAssignmentsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserRoleAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserRoleAssignments", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRoleAssignmentsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserRoleAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserRoleAssignments", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRoleAssignmentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRoleAssignmentsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserRoleAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/userRoleAssignments" : { "get" : { "description" : "Retrieve a List of userRoleAssignments resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[peoplesoft_id]", "in" : "query", "description" : "Filter by peoplesoft_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[role_id]", "in" : "query", "description" : "Filter by role_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usrRole]", "in" : "query", "description" : "Filter by usrRole (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserRoleAssignmentsFields" }, { "$ref" : "#/components/parameters/UserRoleAssignmentsInclude" }, { "$ref" : "#/components/parameters/UserRoleAssignmentsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRoleAssignmentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserRoleAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserRoleAssignments", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRoleAssignmentsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserRoleAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/userRoleAssignments/{id}/usrRole" : { "get" : { "description" : "Retrieve usrRoles related to a userRoleAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRoleAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/UsrRolesFields" }, { "$ref" : "#/components/parameters/UsrRolesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrRolesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsrRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/userRoleAssignments/{id}/relationships/usrRole" : { "get" : { "description" : "Retrieve usrRoles references related to a userRoleAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRoleAssignmentsPrimaryKey" }, { "$ref" : "#/components/parameters/UsrRolesFields" }, { "$ref" : "#/components/parameters/UsrRolesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrRolesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsrRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos/{id}" : { "get" : { "description" : "Retrieve a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" }, { "$ref" : "#/components/parameters/DamagePhotosFields" }, { "$ref" : "#/components/parameters/DamagePhotosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a DamagePhotos", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DamagePhotos", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos" : { "get" : { "description" : "Retrieve a List of damagePhotos resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[volume_id]", "in" : "query", "description" : "Filter by volume_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[priv]", "in" : "query", "description" : "Filter by priv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filetype]", "in" : "query", "description" : "Filter by filetype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filename]", "in" : "query", "description" : "Filter by filename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filesize]", "in" : "query", "description" : "Filter by filesize (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_id]", "in" : "query", "description" : "Filter by attachment_entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_int]", "in" : "query", "description" : "Filter by pk1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_name]", "in" : "query", "description" : "Filter by attachment_entity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_table]", "in" : "query", "description" : "Filter by entity_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[protocol]", "in" : "query", "description" : "Filter by protocol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fullUrl]", "in" : "query", "description" : "Filter by fullUrl (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fulltnUrl]", "in" : "query", "description" : "Filter by fulltnUrl (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[number]", "in" : "query", "description" : "Filter by number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentEntities]", "in" : "query", "description" : "Filter by attachmentEntities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[host]", "in" : "query", "description" : "Filter by host (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entityID]", "in" : "query", "description" : "Filter by entityID (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vol]", "in" : "query", "description" : "Filter by vol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamagePhotosFields" }, { "$ref" : "#/components/parameters/DamagePhotosInclude" }, { "$ref" : "#/components/parameters/DamagePhotosSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a DamagePhotos", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create damagePhotos relationship to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete damagePhotos relationship to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update damagePhotos relationship to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos/{id}/attachmentEntities" : { "get" : { "description" : "Retrieve attachEntities related to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" }, { "$ref" : "#/components/parameters/AttachEntitiesFields" }, { "$ref" : "#/components/parameters/AttachEntitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create damagePhotos relationship to a attachEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete damagePhotos relationship to a attachEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update damagePhotos relationship to a attachEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos/{id}/cmsInvestigationDetail" : { "get" : { "description" : "Retrieve cmsInvestigationDetails related to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create damagePhotos relationship to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete damagePhotos relationship to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update damagePhotos relationship to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos/{id}/investigationDetail" : { "get" : { "description" : "Retrieve investigationDetails related to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create damagePhotos relationship to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete damagePhotos relationship to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update damagePhotos relationship to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create damagePhotos relationship to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete damagePhotos relationship to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update damagePhotos relationship to a damages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos/{id}/relationships/attachmentEntities" : { "get" : { "description" : "Retrieve attachEntities references related to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" }, { "$ref" : "#/components/parameters/AttachEntitiesFields" }, { "$ref" : "#/components/parameters/AttachEntitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create damagePhotos relationship to a attachEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete damagePhotos relationship to a attachEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update damagePhotos relationship to a attachEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos/{id}/relationships/cmsInvestigationDetail" : { "get" : { "description" : "Retrieve cmsInvestigationDetails references related to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create damagePhotos relationship to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete damagePhotos relationship to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update damagePhotos relationship to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damagePhotos/{id}/relationships/investigationDetail" : { "get" : { "description" : "Retrieve investigationDetails references related to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create damagePhotos relationship to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete damagePhotos relationship to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update damagePhotos relationship to a investigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamagePhotosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventories/{id}" : { "get" : { "description" : "Retrieve a verizonWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a VerizonWirelessInventories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a VerizonWirelessInventories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventories" : { "get" : { "description" : "Retrieve a List of verizonWirelessInventories resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cost_center]", "in" : "query", "description" : "Filter by cost_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ecpd]", "in" : "query", "description" : "Filter by ecpd (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_acc_num]", "in" : "query", "description" : "Filter by bill_acc_num (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_cycle_id]", "in" : "query", "description" : "Filter by bill_cycle_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[iccid]", "in" : "query", "description" : "Filter by iccid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[esn]", "in" : "query", "description" : "Filter by esn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ip]", "in" : "query", "description" : "Filter by ip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pplan_id]", "in" : "query", "description" : "Filter by pplan_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pplan_desc]", "in" : "query", "description" : "Filter by pplan_desc (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_make]", "in" : "query", "description" : "Filter by device_make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_model]", "in" : "query", "description" : "Filter by device_model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cust_mtn_stat]", "in" : "query", "description" : "Filter by cust_mtn_stat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason_code]", "in" : "query", "description" : "Filter by reason_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activation_date]", "in" : "query", "description" : "Filter by activation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[upgrade_elig_date]", "in" : "query", "description" : "Filter by upgrade_elig_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_upgrade_date]", "in" : "query", "description" : "Filter by last_upgrade_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[suspn_deactv_dt]", "in" : "query", "description" : "Filter by suspn_deactv_dt (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mtn_stat_eff_date]", "in" : "query", "description" : "Filter by mtn_stat_eff_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[auto_reconn_date]", "in" : "query", "description" : "Filter by auto_reconn_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ip_pool_name]", "in" : "query", "description" : "Filter by ip_pool_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bsns_id]", "in" : "query", "description" : "Filter by bsns_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[given_nme]", "in" : "query", "description" : "Filter by given_nme (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mdl_init]", "in" : "query", "description" : "Filter by mdl_init (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[family_nme]", "in" : "query", "description" : "Filter by family_nme (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ccntrct_end_dt]", "in" : "query", "description" : "Filter by ccntrct_end_dt (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pplan_cost]", "in" : "query", "description" : "Filter by pplan_cost (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[min]", "in" : "query", "description" : "Filter by min (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ccntrct_start_dt]", "in" : "query", "description" : "Filter by ccntrct_start_dt (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[current_dvcid]", "in" : "query", "description" : "Filter by current_dvcid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sfo_code_cnt]", "in" : "query", "description" : "Filter by sfo_code_cnt (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[listSfos]", "in" : "query", "description" : "Filter by listSfos (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[verizonWirelessInventorySfos]", "in" : "query", "description" : "Filter by verizonWirelessInventorySfos (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesInclude" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a VerizonWirelessInventories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventories/{id}/verizonWirelessInventorySfos" : { "get" : { "description" : "Retrieve verizonWirelessInventorySfos related to a verizonWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mdn]", "in" : "query", "description" : "Filter by mdn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sfo_code]", "in" : "query", "description" : "Filter by sfo_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sfo_description]", "in" : "query", "description" : "Filter by sfo_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[verizonWirelessInventory]", "in" : "query", "description" : "Filter by verizonWirelessInventory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventories/{id}/relationships/verizonWirelessInventorySfos" : { "get" : { "description" : "Retrieve verizonWirelessInventorySfos references related to a verizonWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mdn]", "in" : "query", "description" : "Filter by mdn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sfo_code]", "in" : "query", "description" : "Filter by sfo_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sfo_description]", "in" : "query", "description" : "Filter by sfo_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[verizonWirelessInventory]", "in" : "query", "description" : "Filter by verizonWirelessInventory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/passkeyUsers/{id}" : { "get" : { "description" : "Retrieve a passkeyUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" }, { "$ref" : "#/components/parameters/PasskeyUsersFields" }, { "$ref" : "#/components/parameters/PasskeyUsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourceResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a PasskeyUsers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a PasskeyUsers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/passkeyUsers" : { "get" : { "description" : "Retrieve a List of passkeyUsers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_type]", "in" : "query", "description" : "Filter by user_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_name]", "in" : "query", "description" : "Filter by user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passkeyCredentials]", "in" : "query", "description" : "Filter by passkeyCredentials (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersFields" }, { "$ref" : "#/components/parameters/PasskeyUsersInclude" }, { "$ref" : "#/components/parameters/PasskeyUsersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyUsersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a PasskeyUsers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PasskeyUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/passkeyUsers/{id}/passkeyCredentials" : { "get" : { "description" : "Retrieve passkeyCredentials related to a passkeyUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passkeyuser_id]", "in" : "query", "description" : "Filter by passkeyuser_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[authenticator_type]", "in" : "query", "description" : "Filter by authenticator_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[credential_id]", "in" : "query", "description" : "Filter by credential_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sign_count]", "in" : "query", "description" : "Filter by sign_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attestation_object]", "in" : "query", "description" : "Filter by attestation_object (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_data]", "in" : "query", "description" : "Filter by client_data (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transports]", "in" : "query", "description" : "Filter by transports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passkeyUser]", "in" : "query", "description" : "Filter by passkeyUser (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsFields" }, { "$ref" : "#/components/parameters/PasskeyCredentialsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create passkeyUsers relationship to a passkeyCredentials resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete passkeyUsers relationship to a passkeyCredentials resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update passkeyUsers relationship to a passkeyCredentials resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/passkeyUsers/{id}/relationships/passkeyCredentials" : { "get" : { "description" : "Retrieve passkeyCredentials references related to a passkeyUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passkeyuser_id]", "in" : "query", "description" : "Filter by passkeyuser_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[authenticator_type]", "in" : "query", "description" : "Filter by authenticator_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[credential_id]", "in" : "query", "description" : "Filter by credential_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sign_count]", "in" : "query", "description" : "Filter by sign_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attestation_object]", "in" : "query", "description" : "Filter by attestation_object (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_data]", "in" : "query", "description" : "Filter by client_data (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transports]", "in" : "query", "description" : "Filter by transports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passkeyUser]", "in" : "query", "description" : "Filter by passkeyUser (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PasskeyCredentialsFields" }, { "$ref" : "#/components/parameters/PasskeyCredentialsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create passkeyUsers relationship to a passkeyCredentials resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete passkeyUsers relationship to a passkeyCredentials resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update passkeyUsers relationship to a passkeyCredentials resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PasskeyUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PasskeyCredentialsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messages/{id}" : { "get" : { "description" : "Retrieve a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" }, { "$ref" : "#/components/parameters/MessagesFields" }, { "$ref" : "#/components/parameters/MessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Messages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Messages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messages" : { "get" : { "description" : "Retrieve a List of messages resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subject]", "in" : "query", "description" : "Filter by subject (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_preview]", "in" : "query", "description" : "Filter by message_preview (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_acknowledgement]", "in" : "query", "description" : "Filter by require_acknowledgement (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unreadCount]", "in" : "query", "description" : "Filter by unreadCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[readCount]", "in" : "query", "description" : "Filter by readCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sentCount]", "in" : "query", "description" : "Filter by sentCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledgedCount]", "in" : "query", "description" : "Filter by acknowledgedCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeMessages]", "in" : "query", "description" : "Filter by employeeMessages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/MessagesFields" }, { "$ref" : "#/components/parameters/MessagesInclude" }, { "$ref" : "#/components/parameters/MessagesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Messages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messages/{id}/employeeMessages" : { "get" : { "description" : "Retrieve employeeMessages related to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sent_at]", "in" : "query", "description" : "Filter by sent_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_read_at]", "in" : "query", "description" : "Filter by first_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_read_at]", "in" : "query", "description" : "Filter by last_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cleared_at]", "in" : "query", "description" : "Filter by cleared_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledged_at]", "in" : "query", "description" : "Filter by acknowledged_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[channel]", "in" : "query", "description" : "Filter by channel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recipient_email]", "in" : "query", "description" : "Filter by recipient_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_detail]", "in" : "query", "description" : "Filter by delivery_detail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_attempts]", "in" : "query", "description" : "Filter by delivery_attempts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimed_at]", "in" : "query", "description" : "Filter by claimed_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerInfo]", "in" : "query", "description" : "Filter by schedulerInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messageWithCount]", "in" : "query", "description" : "Filter by messageWithCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesFields" }, { "$ref" : "#/components/parameters/EmployeeMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create messages relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete messages relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update messages relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messages/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create messages relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete messages relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update messages relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messages/{id}/relationships/employeeMessages" : { "get" : { "description" : "Retrieve employeeMessages references related to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sent_at]", "in" : "query", "description" : "Filter by sent_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_read_at]", "in" : "query", "description" : "Filter by first_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_read_at]", "in" : "query", "description" : "Filter by last_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cleared_at]", "in" : "query", "description" : "Filter by cleared_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledged_at]", "in" : "query", "description" : "Filter by acknowledged_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[channel]", "in" : "query", "description" : "Filter by channel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recipient_email]", "in" : "query", "description" : "Filter by recipient_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_detail]", "in" : "query", "description" : "Filter by delivery_detail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_attempts]", "in" : "query", "description" : "Filter by delivery_attempts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimed_at]", "in" : "query", "description" : "Filter by claimed_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerInfo]", "in" : "query", "description" : "Filter by schedulerInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messageWithCount]", "in" : "query", "description" : "Filter by messageWithCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesFields" }, { "$ref" : "#/components/parameters/EmployeeMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create messages relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete messages relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update messages relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messages/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create messages relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete messages relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update messages relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailLines/{id}" : { "get" : { "description" : "Retrieve a investigationDetailLines resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailLinesPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailLinesFields" }, { "$ref" : "#/components/parameters/InvestigationDetailLinesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a InvestigationDetailLines", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailLinesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a InvestigationDetailLines", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailLinesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailLinesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailLines" : { "get" : { "description" : "Retrieve a List of investigationDetailLines resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_sent]", "in" : "query", "description" : "Filter by report_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_to_customer]", "in" : "query", "description" : "Filter by billable_to_customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_date]", "in" : "query", "description" : "Filter by accepted_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_sent_date]", "in" : "query", "description" : "Filter by report_sent_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_id]", "in" : "query", "description" : "Filter by contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cdc_code]", "in" : "query", "description" : "Filter by cdc_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjuster_time]", "in" : "query", "description" : "Filter by adjuster_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailLinesFields" }, { "$ref" : "#/components/parameters/InvestigationDetailLinesInclude" }, { "$ref" : "#/components/parameters/InvestigationDetailLinesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a InvestigationDetailLines", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailLinesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailLines/{id}/cmsInvestigationDetail" : { "get" : { "description" : "Retrieve cmsInvestigationDetails related to a investigationDetailLines resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailLinesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailLines/{id}/relationships/cmsInvestigationDetail" : { "get" : { "description" : "Retrieve cmsInvestigationDetails references related to a investigationDetailLines resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailLinesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/sessions/{id}" : { "get" : { "description" : "Retrieve a sessions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" }, { "$ref" : "#/components/parameters/SessionsFields" }, { "$ref" : "#/components/parameters/SessionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Sessions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Sessions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/sessions" : { "get" : { "description" : "Retrieve a List of sessions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[event]", "in" : "query", "description" : "Filter by event (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[event_time]", "in" : "query", "description" : "Filter by event_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SessionsFields" }, { "$ref" : "#/components/parameters/SessionsInclude" }, { "$ref" : "#/components/parameters/SessionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SessionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Sessions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SessionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/sessions/{id}/user" : { "get" : { "description" : "Retrieve users related to a sessions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" }, { "$ref" : "#/components/parameters/UsersFields" }, { "$ref" : "#/components/parameters/UsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create sessions relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete sessions relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update sessions relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/sessions/{id}/relationships/user" : { "get" : { "description" : "Retrieve users references related to a sessions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" }, { "$ref" : "#/components/parameters/UsersFields" }, { "$ref" : "#/components/parameters/UsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create sessions relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete sessions relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update sessions relationship to a users resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SessionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}" : { "get" : { "description" : "Retrieve a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Locations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Locations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations" : { "get" : { "description" : "Retrieve a List of locations resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_type_id]", "in" : "query", "description" : "Filter by location_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_id]", "in" : "query", "description" : "Filter by country_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districts]", "in" : "query", "description" : "Filter by districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" }, { "$ref" : "#/components/parameters/LocationsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Locations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/districtLocations" : { "get" : { "description" : "Retrieve districtLocations related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsFields" }, { "$ref" : "#/components/parameters/DistrictLocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/country" : { "get" : { "description" : "Retrieve countries related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/CountriesFields" }, { "$ref" : "#/components/parameters/CountriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create locations relationship to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete locations relationship to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update locations relationship to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/state" : { "get" : { "description" : "Retrieve states related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/assets" : { "get" : { "description" : "Retrieve assets related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/districts" : { "get" : { "description" : "Retrieve districts related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_code]", "in" : "query", "description" : "Filter by district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_name]", "in" : "query", "description" : "Filter by district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_manager_employee_id]", "in" : "query", "description" : "Filter by district_manager_employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employees]", "in" : "query", "description" : "Filter by employees (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesOnLoans]", "in" : "query", "description" : "Filter by employeesOnLoans (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAssets]", "in" : "query", "description" : "Filter by employeesActiveNoAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisorGroups]", "in" : "query", "description" : "Filter by supervisorGroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userDataAccesses]", "in" : "query", "description" : "Filter by userDataAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locations]", "in" : "query", "description" : "Filter by locations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/relationships/districtLocations" : { "get" : { "description" : "Retrieve districtLocations references related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsFields" }, { "$ref" : "#/components/parameters/DistrictLocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/relationships/country" : { "get" : { "description" : "Retrieve countries references related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/CountriesFields" }, { "$ref" : "#/components/parameters/CountriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create locations relationship to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete locations relationship to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update locations relationship to a countries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CountriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CountriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/relationships/state" : { "get" : { "description" : "Retrieve states references related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/relationships/assets" : { "get" : { "description" : "Retrieve assets references related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/locations/{id}/relationships/districts" : { "get" : { "description" : "Retrieve districts references related to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_code]", "in" : "query", "description" : "Filter by district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_name]", "in" : "query", "description" : "Filter by district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_manager_employee_id]", "in" : "query", "description" : "Filter by district_manager_employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employees]", "in" : "query", "description" : "Filter by employees (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesOnLoans]", "in" : "query", "description" : "Filter by employeesOnLoans (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAssets]", "in" : "query", "description" : "Filter by employeesActiveNoAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisorGroups]", "in" : "query", "description" : "Filter by supervisorGroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userDataAccesses]", "in" : "query", "description" : "Filter by userDataAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locations]", "in" : "query", "description" : "Filter by locations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContracts/{id}" : { "get" : { "description" : "Retrieve a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CustomerContracts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CustomerContracts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContracts" : { "get" : { "description" : "Retrieve a List of customerContracts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_status]", "in" : "query", "description" : "Filter by item_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccountContractAccesses]", "in" : "query", "description" : "Filter by userAccountContractAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContractSetting]", "in" : "query", "description" : "Filter by customerContractSetting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" }, { "$ref" : "#/components/parameters/CustomerContractsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CustomerContracts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContracts/{id}/userAccountContractAccesses" : { "get" : { "description" : "Retrieve userAccountContractAccesses related to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_name]", "in" : "query", "description" : "Filter by cp_user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesFields" }, { "$ref" : "#/components/parameters/UserAccountContractAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContracts/{id}/userAccesses" : { "get" : { "description" : "Retrieve userAccesses related to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_states]", "in" : "query", "description" : "Filter by customer_states (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccessesFields" }, { "$ref" : "#/components/parameters/UserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContracts/{id}/customerContractSetting" : { "get" : { "description" : "Retrieve customerContractSettings related to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractSettingsFields" }, { "$ref" : "#/components/parameters/CustomerContractSettingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerContracts relationship to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerContracts relationship to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerContracts relationship to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContracts/{id}/relationships/userAccountContractAccesses" : { "get" : { "description" : "Retrieve userAccountContractAccesses references related to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_name]", "in" : "query", "description" : "Filter by cp_user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccountContractAccessesFields" }, { "$ref" : "#/components/parameters/UserAccountContractAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccountContractAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContracts/{id}/relationships/userAccesses" : { "get" : { "description" : "Retrieve userAccesses references related to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_states]", "in" : "query", "description" : "Filter by customer_states (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccessesFields" }, { "$ref" : "#/components/parameters/UserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContracts/{id}/relationships/customerContractSetting" : { "get" : { "description" : "Retrieve customerContractSettings references related to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractSettingsFields" }, { "$ref" : "#/components/parameters/CustomerContractSettingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerContracts relationship to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerContracts relationship to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerContracts relationship to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/wsUsers/{id}" : { "get" : { "description" : "Retrieve a wsUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" }, { "$ref" : "#/components/parameters/WsUsersFields" }, { "$ref" : "#/components/parameters/WsUsersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourceResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a WsUsers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a WsUsers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/wsUsers" : { "get" : { "description" : "Retrieve a List of wsUsers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_name]", "in" : "query", "description" : "Filter by user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password]", "in" : "query", "description" : "Filter by password (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_name]", "in" : "query", "description" : "Filter by entity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[token]", "in" : "query", "description" : "Filter by token (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[new_password]", "in" : "query", "description" : "Filter by new_password (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WsUsersFields" }, { "$ref" : "#/components/parameters/WsUsersInclude" }, { "$ref" : "#/components/parameters/WsUsersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WsUsersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a WsUsers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WsUsersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/wsUsers/{id}/token" : { "get" : { "description" : "Retrieve tokens related to a wsUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" }, { "$ref" : "#/components/parameters/TokensFields" }, { "$ref" : "#/components/parameters/TokensInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create wsUsers relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete wsUsers relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update wsUsers relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webservices/1.0/wsUsers/{id}/relationships/token" : { "get" : { "description" : "Retrieve tokens references related to a wsUsers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" }, { "$ref" : "#/components/parameters/TokensFields" }, { "$ref" : "#/components/parameters/TokensInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create wsUsers relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete wsUsers relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update wsUsers relationship to a tokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WsUsersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/TokensResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/journals/{id}" : { "get" : { "description" : "Retrieve a journals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/JournalsPrimaryKey" }, { "$ref" : "#/components/parameters/JournalsFields" }, { "$ref" : "#/components/parameters/JournalsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/JournalsResourceResponse" }, "202" : { "$ref" : "#/components/responses/JournalsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Journals", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/JournalsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/JournalsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Journals", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/JournalsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JournalsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/JournalsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/journals" : { "get" : { "description" : "Retrieve a List of journals resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[journal_date]", "in" : "query", "description" : "Filter by journal_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[priv]", "in" : "query", "description" : "Filter by priv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[app_bread_crumbs_id]", "in" : "query", "description" : "Filter by app_bread_crumbs_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1]", "in" : "query", "description" : "Filter by pk1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2]", "in" : "query", "description" : "Filter by pk2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3]", "in" : "query", "description" : "Filter by pk3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[journal_text]", "in" : "query", "description" : "Filter by journal_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reminder_date]", "in" : "query", "description" : "Filter by reminder_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reminder_flag]", "in" : "query", "description" : "Filter by reminder_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by_id]", "in" : "query", "description" : "Filter by created_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by_id]", "in" : "query", "description" : "Filter by last_updated_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[due_date]", "in" : "query", "description" : "Filter by due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[createdBy]", "in" : "query", "description" : "Filter by createdBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[updatedBy]", "in" : "query", "description" : "Filter by updatedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/JournalsFields" }, { "$ref" : "#/components/parameters/JournalsInclude" }, { "$ref" : "#/components/parameters/JournalsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/JournalsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/JournalsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Journals", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JournalsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JournalsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/JournalsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/journals/{id}/createdBy" : { "get" : { "description" : "Retrieve employees related to a journals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/JournalsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/journals/{id}/updatedBy" : { "get" : { "description" : "Retrieve employees related to a journals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/JournalsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/journals/{id}/relationships/createdBy" : { "get" : { "description" : "Retrieve employees references related to a journals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/JournalsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/journals/{id}/relationships/updatedBy" : { "get" : { "description" : "Retrieve employees references related to a journals resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/JournalsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodes/{id}" : { "get" : { "description" : "Retrieve a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodesPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodesFields" }, { "$ref" : "#/components/parameters/QuickCodesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a QuickCodes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a QuickCodes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodes" : { "get" : { "description" : "Retrieve a List of quickCodes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCodeValues]", "in" : "query", "description" : "Filter by quickCodeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributeMappings]", "in" : "query", "description" : "Filter by attributeMappings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuickCodesFields" }, { "$ref" : "#/components/parameters/QuickCodesInclude" }, { "$ref" : "#/components/parameters/QuickCodesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a QuickCodes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodes/{id}/quickCodeValues" : { "get" : { "description" : "Retrieve quickCodeValues related to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesFields" }, { "$ref" : "#/components/parameters/QuickCodeValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValuesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodes/{id}/attributeMappings" : { "get" : { "description" : "Retrieve attributeMappings related to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type_id]", "in" : "query", "description" : "Filter by asset_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodes/{id}/relationships/quickCodeValues" : { "get" : { "description" : "Retrieve quickCodeValues references related to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuesFields" }, { "$ref" : "#/components/parameters/QuickCodeValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/quickCodes/{id}/relationships/attributeMappings" : { "get" : { "description" : "Retrieve attributeMappings references related to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type_id]", "in" : "query", "description" : "Filter by asset_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/deletionTypes/{id}" : { "get" : { "description" : "Retrieve a deletionTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeletionTypesPrimaryKey" }, { "$ref" : "#/components/parameters/DeletionTypesFields" }, { "$ref" : "#/components/parameters/DeletionTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a DeletionTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeletionTypesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DeletionTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeletionTypesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/deletionTypes" : { "get" : { "description" : "Retrieve a List of deletionTypes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DeletionTypesFields" }, { "$ref" : "#/components/parameters/DeletionTypesInclude" }, { "$ref" : "#/components/parameters/DeletionTypesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeletionTypesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a DeletionTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DeletionTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/deletionTypes/{id}/assets" : { "get" : { "description" : "Retrieve assets related to a deletionTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeletionTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/deletionTypes/{id}/relationships/assets" : { "get" : { "description" : "Retrieve assets references related to a deletionTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DeletionTypesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/flatRateCustomers/{id}" : { "get" : { "description" : "Retrieve a flatRateCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/FlatRateCustomersFields" }, { "$ref" : "#/components/parameters/FlatRateCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FlatRateCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a FlatRateCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a FlatRateCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FlatRateCustomersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/flatRateCustomers" : { "get" : { "description" : "Retrieve a List of flatRateCustomers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_guarantee]", "in" : "query", "description" : "Filter by count_against_quality_guarantee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[auto_approve_claims]", "in" : "query", "description" : "Filter by auto_approve_claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approval_limit]", "in" : "query", "description" : "Filter by approval_limit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility]", "in" : "query", "description" : "Filter by facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersFields" }, { "$ref" : "#/components/parameters/FlatRateCustomersInclude" }, { "$ref" : "#/components/parameters/FlatRateCustomersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FlatRateCustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a FlatRateCustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FlatRateCustomersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/FlatRateCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/flatRateCustomers/{id}/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers related to a flatRateCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/flatRateCustomers/{id}/facility" : { "get" : { "description" : "Retrieve facilities related to a flatRateCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/FacilitiesFields" }, { "$ref" : "#/components/parameters/FacilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FacilitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/FacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/flatRateCustomers/{id}/state" : { "get" : { "description" : "Retrieve states related to a flatRateCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/flatRateCustomers/{id}/relationships/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers references related to a flatRateCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/flatRateCustomers/{id}/relationships/facility" : { "get" : { "description" : "Retrieve facilities references related to a flatRateCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/FacilitiesFields" }, { "$ref" : "#/components/parameters/FacilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FacilitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FacilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/flatRateCustomers/{id}/relationships/state" : { "get" : { "description" : "Retrieve states references related to a flatRateCustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/FlatRateCustomersPrimaryKey" }, { "$ref" : "#/components/parameters/StatesFields" }, { "$ref" : "#/components/parameters/StatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districtBoundaries/{id}" : { "get" : { "description" : "Retrieve a districtBoundaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictBoundariesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictBoundariesFields" }, { "$ref" : "#/components/parameters/DistrictBoundariesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictBoundariesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictBoundariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "delete" : { "description" : "Delete a DistrictBoundaries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictBoundariesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DistrictBoundariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DistrictBoundaries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictBoundariesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictBoundariesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DistrictBoundariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/districtBoundaries" : { "get" : { "description" : "Retrieve a List of districtBoundaries resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[color]", "in" : "query", "description" : "Filter by color (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_info]", "in" : "query", "description" : "Filter by contact_info (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[distric_name]", "in" : "query", "description" : "Filter by distric_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boundaries]", "in" : "query", "description" : "Filter by boundaries (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DistrictBoundariesFields" }, { "$ref" : "#/components/parameters/DistrictBoundariesInclude" }, { "$ref" : "#/components/parameters/DistrictBoundariesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictBoundariesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictBoundariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create a DistrictBoundaries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictBoundariesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictBoundariesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DistrictBoundariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/userDataAccesses/{id}" : { "get" : { "description" : "Retrieve a cmsUserDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsUserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsUserDataAccessesFields" }, { "$ref" : "#/components/parameters/CmsUserDataAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsUserDataAccessesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsUserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CmsUserDataAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsUserDataAccessesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CmsUserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CmsUserDataAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsUserDataAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsUserDataAccessesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsUserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/userDataAccesses" : { "get" : { "description" : "Retrieve a List of cmsUserDataAccesses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[peoplesoft_id]", "in" : "query", "description" : "Filter by peoplesoft_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_districts]", "in" : "query", "description" : "Filter by all_districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CmsUserDataAccessesFields" }, { "$ref" : "#/components/parameters/CmsUserDataAccessesInclude" }, { "$ref" : "#/components/parameters/CmsUserDataAccessesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsUserDataAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CmsUserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CmsUserDataAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsUserDataAccessesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsUserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/userDataAccesses/{id}/district" : { "get" : { "description" : "Retrieve districts related to a cmsUserDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsUserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/userDataAccesses/{id}/relationships/district" : { "get" : { "description" : "Retrieve districts references related to a cmsUserDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsUserDataAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentTags/{id}" : { "get" : { "description" : "Retrieve a tkpAttachmentTags resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentTagsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsFields" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TkpAttachmentTags", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentTagsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TkpAttachmentTags", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentTagsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentTagsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentTags" : { "get" : { "description" : "Retrieve a List of tkpAttachmentTags resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[queued_at]", "in" : "query", "description" : "Filter by queued_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[respond]", "in" : "query", "description" : "Filter by respond (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[processed_at]", "in" : "query", "description" : "Filter by processed_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_time]", "in" : "query", "description" : "Filter by created_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[format]", "in" : "query", "description" : "Filter by format (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geom]", "in" : "query", "description" : "Filter by geom (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_electric]", "in" : "query", "description" : "Filter by utility_electric (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_telecom]", "in" : "query", "description" : "Filter by utility_telecom (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_gas]", "in" : "query", "description" : "Filter by utility_gas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_water]", "in" : "query", "description" : "Filter by utility_water (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_sewer]", "in" : "query", "description" : "Filter by utility_sewer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[flags_electric]", "in" : "query", "description" : "Filter by flags_electric (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[flags_gas]", "in" : "query", "description" : "Filter by flags_gas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[flags_sewer]", "in" : "query", "description" : "Filter by flags_sewer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[flags_telecom]", "in" : "query", "description" : "Filter by flags_telecom (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[flags_water]", "in" : "query", "description" : "Filter by flags_water (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[nearby_electric]", "in" : "query", "description" : "Filter by nearby_electric (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[nearby_gas]", "in" : "query", "description" : "Filter by nearby_gas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[nearby_sewer]", "in" : "query", "description" : "Filter by nearby_sewer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[nearby_telecom]", "in" : "query", "description" : "Filter by nearby_telecom (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[nearby_water]", "in" : "query", "description" : "Filter by nearby_water (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[clear_electric]", "in" : "query", "description" : "Filter by clear_electric (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[clear_gas]", "in" : "query", "description" : "Filter by clear_gas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[clear_sewer]", "in" : "query", "description" : "Filter by clear_sewer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[clear_telecom]", "in" : "query", "description" : "Filter by clear_telecom (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[clear_water]", "in" : "query", "description" : "Filter by clear_water (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[extra_damage]", "in" : "query", "description" : "Filter by extra_damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[extra_survey_pink]", "in" : "query", "description" : "Filter by extra_survey_pink (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[extra_whitelining]", "in" : "query", "description" : "Filter by extra_whitelining (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_fire_hydrant]", "in" : "query", "description" : "Filter by infra_fire_hydrant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_manhole]", "in" : "query", "description" : "Filter by infra_manhole (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_utility_hookup]", "in" : "query", "description" : "Filter by infra_utility_hookup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_pedestal_small]", "in" : "query", "description" : "Filter by infra_pedestal_small (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_pedestal_large]", "in" : "query", "description" : "Filter by infra_pedestal_large (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_meter_gas]", "in" : "query", "description" : "Filter by infra_meter_gas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_meter_water]", "in" : "query", "description" : "Filter by infra_meter_water (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_meter_electric]", "in" : "query", "description" : "Filter by infra_meter_electric (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_pipeline_poles]", "in" : "query", "description" : "Filter by infra_pipeline_poles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_hvac]", "in" : "query", "description" : "Filter by infra_hvac (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_bollard]", "in" : "query", "description" : "Filter by infra_bollard (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_erosion_wattle]", "in" : "query", "description" : "Filter by infra_erosion_wattle (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_garden_hose]", "in" : "query", "description" : "Filter by infra_garden_hose (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_cable_debris]", "in" : "query", "description" : "Filter by infra_cable_debris (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_electric_wires]", "in" : "query", "description" : "Filter by infra_electric_wires (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[infra_guy_wire]", "in" : "query", "description" : "Filter by infra_guy_wire (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[road_curb_red]", "in" : "query", "description" : "Filter by road_curb_red (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[road_curb_white]", "in" : "query", "description" : "Filter by road_curb_white (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[road_curb_yellow]", "in" : "query", "description" : "Filter by road_curb_yellow (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[road_curb_blue]", "in" : "query", "description" : "Filter by road_curb_blue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[road_line_yellow]", "in" : "query", "description" : "Filter by road_line_yellow (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[road_line_blue]", "in" : "query", "description" : "Filter by road_line_blue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[road_line_white]", "in" : "query", "description" : "Filter by road_line_white (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[road_line_red]", "in" : "query", "description" : "Filter by road_line_red (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[road_crosswalk]", "in" : "query", "description" : "Filter by road_crosswalk (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[equip_cones]", "in" : "query", "description" : "Filter by equip_cones (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[equip_locator]", "in" : "query", "description" : "Filter by equip_locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[equip_construction]", "in" : "query", "description" : "Filter by equip_construction (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[equip_usic_truck]", "in" : "query", "description" : "Filter by equip_usic_truck (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[scene_human]", "in" : "query", "description" : "Filter by scene_human (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[scene_trash_box]", "in" : "query", "description" : "Filter by scene_trash_box (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[scene_caution_tape]", "in" : "query", "description" : "Filter by scene_caution_tape (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[scene_protective_fence]", "in" : "query", "description" : "Filter by scene_protective_fence (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[scene_screenshot]", "in" : "query", "description" : "Filter by scene_screenshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_residential]", "in" : "query", "description" : "Filter by type_residential (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_commercial]", "in" : "query", "description" : "Filter by type_commercial (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_roadway]", "in" : "query", "description" : "Filter by type_roadway (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_construction]", "in" : "query", "description" : "Filter by type_construction (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_rural]", "in" : "query", "description" : "Filter by type_rural (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_city]", "in" : "query", "description" : "Filter by type_city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_new_homes]", "in" : "query", "description" : "Filter by type_new_homes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[weather_rain]", "in" : "query", "description" : "Filter by weather_rain (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[weather_snow]", "in" : "query", "description" : "Filter by weather_snow (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[weather_dry]", "in" : "query", "description" : "Filter by weather_dry (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[weather_dark]", "in" : "query", "description" : "Filter by weather_dark (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_grass]", "in" : "query", "description" : "Filter by ground_grass (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_dry_grass]", "in" : "query", "description" : "Filter by ground_dry_grass (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_mulch]", "in" : "query", "description" : "Filter by ground_mulch (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_dirt]", "in" : "query", "description" : "Filter by ground_dirt (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_construction_mud]", "in" : "query", "description" : "Filter by ground_construction_mud (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_gravel]", "in" : "query", "description" : "Filter by ground_gravel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_asphalt]", "in" : "query", "description" : "Filter by ground_asphalt (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_concrete]", "in" : "query", "description" : "Filter by ground_concrete (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_pavers]", "in" : "query", "description" : "Filter by ground_pavers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_fallen_leaves]", "in" : "query", "description" : "Filter by ground_fallen_leaves (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ground_snow]", "in" : "query", "description" : "Filter by ground_snow (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TkpAttachmentTagsFields" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsInclude" }, { "$ref" : "#/components/parameters/TkpAttachmentTagsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TkpAttachmentTags", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentTagsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpAttachmentTagsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccessView/{id}" : { "get" : { "description" : "Retrieve a userDataAccessView resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessViewPrimaryKey" }, { "$ref" : "#/components/parameters/UserDataAccessViewFields" }, { "$ref" : "#/components/parameters/UserDataAccessViewInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessViewResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserDataAccessView", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessViewPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserDataAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserDataAccessView", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserDataAccessViewPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessViewPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserDataAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userDataAccessView" : { "get" : { "description" : "Retrieve a List of userDataAccessView resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_name]", "in" : "query", "description" : "Filter by district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserDataAccessViewFields" }, { "$ref" : "#/components/parameters/UserDataAccessViewInclude" }, { "$ref" : "#/components/parameters/UserDataAccessViewSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessViewResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserDataAccessView", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessViewPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessViewResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserDataAccessViewResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/employeeMessages/{id}" : { "get" : { "description" : "Retrieve a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeeMessagesFields" }, { "$ref" : "#/components/parameters/EmployeeMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "delete" : { "description" : "Delete a EmployeeMessages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a EmployeeMessages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/messaging/1.0/employeeMessages" : { "get" : { "description" : "Retrieve a List of employeeMessages resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sent_at]", "in" : "query", "description" : "Filter by sent_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_read_at]", "in" : "query", "description" : "Filter by first_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_read_at]", "in" : "query", "description" : "Filter by last_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cleared_at]", "in" : "query", "description" : "Filter by cleared_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledged_at]", "in" : "query", "description" : "Filter by acknowledged_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[channel]", "in" : "query", "description" : "Filter by channel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recipient_email]", "in" : "query", "description" : "Filter by recipient_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_detail]", "in" : "query", "description" : "Filter by delivery_detail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_attempts]", "in" : "query", "description" : "Filter by delivery_attempts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimed_at]", "in" : "query", "description" : "Filter by claimed_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerInfo]", "in" : "query", "description" : "Filter by schedulerInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messageWithCount]", "in" : "query", "description" : "Filter by messageWithCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesFields" }, { "$ref" : "#/components/parameters/EmployeeMessagesInclude" }, { "$ref" : "#/components/parameters/EmployeeMessagesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create a EmployeeMessages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/employeeMessages/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/messaging/1.0/employeeMessages/{id}/message" : { "get" : { "description" : "Retrieve messages related to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/MessagesFields" }, { "$ref" : "#/components/parameters/MessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/messaging/1.0/employeeMessages/{id}/messageWithCount" : { "get" : { "description" : "Retrieve messagesWithCounts related to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/MessagesWithCountsFields" }, { "$ref" : "#/components/parameters/MessagesWithCountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesWithCountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/MessagesWithCountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/messaging/1.0/employeeMessages/{id}/status" : { "get" : { "description" : "Retrieve statuses related to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/StatusesFields" }, { "$ref" : "#/components/parameters/StatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create employeeMessages relationship to a statuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employeeMessages relationship to a statuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employeeMessages relationship to a statuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/messaging/1.0/employeeMessages/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/messaging/1.0/employeeMessages/{id}/relationships/message" : { "get" : { "description" : "Retrieve messages references related to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/MessagesFields" }, { "$ref" : "#/components/parameters/MessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/messaging/1.0/employeeMessages/{id}/relationships/messageWithCount" : { "get" : { "description" : "Retrieve messagesWithCounts references related to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/MessagesWithCountsFields" }, { "$ref" : "#/components/parameters/MessagesWithCountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesWithCountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/MessagesWithCountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/messaging/1.0/employeeMessages/{id}/relationships/status" : { "get" : { "description" : "Retrieve statuses references related to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/StatusesFields" }, { "$ref" : "#/components/parameters/StatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create employeeMessages relationship to a statuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employeeMessages relationship to a statuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employeeMessages relationship to a statuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/StatusesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] } }, "/assetmanager/1.0/attAccounts/{id}" : { "get" : { "description" : "Retrieve a attAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/AttAccountsFields" }, { "$ref" : "#/components/parameters/AttAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AttAccounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttAccountsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AttAccounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttAccountsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attAccounts" : { "get" : { "description" : "Retrieve a List of attAccounts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_group]", "in" : "query", "description" : "Filter by account_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_type]", "in" : "query", "description" : "Filter by account_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_group_id]", "in" : "query", "description" : "Filter by account_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_level_value]", "in" : "query", "description" : "Filter by account_level_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttAccountsFields" }, { "$ref" : "#/components/parameters/AttAccountsInclude" }, { "$ref" : "#/components/parameters/AttAccountsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttAccountsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AttAccounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttAccountsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttAccountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/districtLocations/{id}" : { "get" : { "description" : "Retrieve a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictLocationsFields" }, { "$ref" : "#/components/parameters/DistrictLocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a DistrictLocations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DistrictLocations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/districtLocations" : { "get" : { "description" : "Retrieve a List of districtLocations resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsFields" }, { "$ref" : "#/components/parameters/DistrictLocationsInclude" }, { "$ref" : "#/components/parameters/DistrictLocationsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a DistrictLocations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/districtLocations/{id}/dist" : { "get" : { "description" : "Retrieve districts related to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/districtLocations/{id}/location" : { "get" : { "description" : "Retrieve locations related to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsPrimaryKey" }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/districtLocations/{id}/relationships/dist" : { "get" : { "description" : "Retrieve districts references related to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/districtLocations/{id}/relationships/location" : { "get" : { "description" : "Retrieve locations references related to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsPrimaryKey" }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs/{id}" : { "get" : { "description" : "Retrieve a usrs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Usrs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Usrs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs" : { "get" : { "description" : "Retrieve a List of usrs resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prin_type]", "in" : "query", "description" : "Filter by prin_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[displayname]", "in" : "query", "description" : "Filter by displayname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_id]", "in" : "query", "description" : "Filter by billing_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loginname]", "in" : "query", "description" : "Filter by loginname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstname]", "in" : "query", "description" : "Filter by firstname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastname]", "in" : "query", "description" : "Filter by lastname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportingnode]", "in" : "query", "description" : "Filter by reportingnode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activeuser]", "in" : "query", "description" : "Filter by activeuser (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_expires]", "in" : "query", "description" : "Filter by password_expires (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_sync_date]", "in" : "query", "description" : "Filter by last_sync_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_number]", "in" : "query", "description" : "Filter by employee_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[timesheet_start_date]", "in" : "query", "description" : "Filter by timesheet_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[timesheet_end_date]", "in" : "query", "description" : "Filter by timesheet_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_project_id]", "in" : "query", "description" : "Filter by default_project_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reports_to_id]", "in" : "query", "description" : "Filter by reports_to_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[login_for_customer_id]", "in" : "query", "description" : "Filter by login_for_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[department_number]", "in" : "query", "description" : "Filter by department_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[storage_id]", "in" : "query", "description" : "Filter by storage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[home_phone]", "in" : "query", "description" : "Filter by home_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_lockout]", "in" : "query", "description" : "Filter by password_lockout (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[password_crypt]", "in" : "query", "description" : "Filter by password_crypt (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[failed_logins]", "in" : "query", "description" : "Filter by failed_logins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_number]", "in" : "query", "description" : "Filter by district_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_area]", "in" : "query", "description" : "Filter by work_area (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[peoplesoft_id]", "in" : "query", "description" : "Filter by peoplesoft_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor_group_id]", "in" : "query", "description" : "Filter by supervisor_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_district_id]", "in" : "query", "description" : "Filter by effective_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_supervisor_group_id]", "in" : "query", "description" : "Filter by effective_supervisor_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[truck_number]", "in" : "query", "description" : "Filter by truck_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[at_risk]", "in" : "query", "description" : "Filter by at_risk (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type]", "in" : "query", "description" : "Filter by type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_status]", "in" : "query", "description" : "Filter by user_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[certified]", "in" : "query", "description" : "Filter by certified (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[callout_format]", "in" : "query", "description" : "Filter by callout_format (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_six_ssn]", "in" : "query", "description" : "Filter by last_six_ssn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[org_super_region_id]", "in" : "query", "description" : "Filter by org_super_region_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[org_region_id]", "in" : "query", "description" : "Filter by org_region_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[communication_preference]", "in" : "query", "description" : "Filter by communication_preference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr_manager]", "in" : "query", "description" : "Filter by hr_manager (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[continous_service_date]", "in" : "query", "description" : "Filter by continous_service_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recent_hire_date]", "in" : "query", "description" : "Filter by recent_hire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_district_code]", "in" : "query", "description" : "Filter by workday_district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_region]", "in" : "query", "description" : "Filter by workday_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_super_region]", "in" : "query", "description" : "Filter by workday_super_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[buckets]", "in" : "query", "description" : "Filter by buckets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportsTo]", "in" : "query", "description" : "Filter by reportsTo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" }, { "$ref" : "#/components/parameters/UsrsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Usrs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs/{id}/dueDateExtensions" : { "get" : { "description" : "Retrieve dueDateExtensions related to a usrs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr_id]", "in" : "query", "description" : "Filter by usr_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_extended]", "in" : "query", "description" : "Filter by when_extended (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[due_date]", "in" : "query", "description" : "Filter by due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver_phone]", "in" : "query", "description" : "Filter by approver_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[old_due_date]", "in" : "query", "description" : "Filter by old_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_entered]", "in" : "query", "description" : "Filter by when_entered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsFields" }, { "$ref" : "#/components/parameters/DueDateExtensionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DueDateExtensionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs/{id}/buckets" : { "get" : { "description" : "Retrieve buckets related to a usrs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[screening]", "in" : "query", "description" : "Filter by screening (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[translore]", "in" : "query", "description" : "Filter by translore (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs/{id}/reportsTo" : { "get" : { "description" : "Retrieve usrs related to a usrs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs/{id}/tkpDistrict" : { "get" : { "description" : "Retrieve tkpDistricts related to a usrs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpDistrictsFields" }, { "$ref" : "#/components/parameters/TkpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpDistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs/{id}/relationships/dueDateExtensions" : { "get" : { "description" : "Retrieve dueDateExtensions references related to a usrs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr_id]", "in" : "query", "description" : "Filter by usr_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_extended]", "in" : "query", "description" : "Filter by when_extended (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[due_date]", "in" : "query", "description" : "Filter by due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver_phone]", "in" : "query", "description" : "Filter by approver_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[old_due_date]", "in" : "query", "description" : "Filter by old_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_entered]", "in" : "query", "description" : "Filter by when_entered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsFields" }, { "$ref" : "#/components/parameters/DueDateExtensionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs/{id}/relationships/buckets" : { "get" : { "description" : "Retrieve buckets references related to a usrs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[screening]", "in" : "query", "description" : "Filter by screening (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[translore]", "in" : "query", "description" : "Filter by translore (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs/{id}/relationships/reportsTo" : { "get" : { "description" : "Retrieve usrs references related to a usrs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/usrs/{id}/relationships/tkpDistrict" : { "get" : { "description" : "Retrieve tkpDistricts references related to a usrs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrsPrimaryKey" }, { "$ref" : "#/components/parameters/TkpDistrictsFields" }, { "$ref" : "#/components/parameters/TkpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TkpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevice/{id}" : { "get" : { "description" : "Retrieve a pumpDevice resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" }, { "$ref" : "#/components/parameters/PumpDeviceFields" }, { "$ref" : "#/components/parameters/PumpDeviceInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PumpDeviceResourceResponse" }, "202" : { "$ref" : "#/components/responses/PumpDeviceResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a PumpDevice", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/PumpDeviceResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a PumpDevice", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDevicePatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PumpDeviceResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevice" : { "get" : { "description" : "Retrieve a List of pumpDevice resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pump_date]", "in" : "query", "description" : "Filter by pump_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[safety_screen_triggers_24]", "in" : "query", "description" : "Filter by safety_screen_triggers_24 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[safety_screen_version]", "in" : "query", "description" : "Filter by safety_screen_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model]", "in" : "query", "description" : "Filter by model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[host_name]", "in" : "query", "description" : "Filter by host_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[os_name]", "in" : "query", "description" : "Filter by os_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[os_version]", "in" : "query", "description" : "Filter by os_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ip_address]", "in" : "query", "description" : "Filter by ip_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[free_space]", "in" : "query", "description" : "Filter by free_space (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[memory]", "in" : "query", "description" : "Filter by memory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile_number]", "in" : "query", "description" : "Filter by mobile_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imei]", "in" : "query", "description" : "Filter by imei (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imed]", "in" : "query", "description" : "Filter by imed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[available_gps_ports]", "in" : "query", "description" : "Filter by available_gps_ports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_gps_lock]", "in" : "query", "description" : "Filter by last_gps_lock (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PumpDeviceFields" }, { "$ref" : "#/components/parameters/PumpDeviceInclude" }, { "$ref" : "#/components/parameters/PumpDeviceSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PumpDeviceResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PumpDeviceResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a PumpDevice", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDevicePostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDeviceResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PumpDeviceResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevice/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a pumpDevice resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create pumpDevice relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete pumpDevice relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update pumpDevice relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevice/{id}/asset" : { "get" : { "description" : "Retrieve assets related to a pumpDevice resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create pumpDevice relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete pumpDevice relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update pumpDevice relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevice/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a pumpDevice resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create pumpDevice relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete pumpDevice relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update pumpDevice relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevice/{id}/relationships/asset" : { "get" : { "description" : "Retrieve assets references related to a pumpDevice resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create pumpDevice relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete pumpDevice relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update pumpDevice relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/netmotionDevices/{id}" : { "get" : { "description" : "Retrieve a netmotionDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NetmotionDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/NetmotionDevicesFields" }, { "$ref" : "#/components/parameters/NetmotionDevicesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/NetmotionDevicesResourceResponse" }, "202" : { "$ref" : "#/components/responses/NetmotionDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a NetmotionDevices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NetmotionDevicesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/NetmotionDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a NetmotionDevices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NetmotionDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NetmotionDevicesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/NetmotionDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/netmotionDevices" : { "get" : { "description" : "Retrieve a List of netmotionDevices resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[device_group]", "in" : "query", "description" : "Filter by device_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disconnect_reason]", "in" : "query", "description" : "Filter by disconnect_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_connect]", "in" : "query", "description" : "Filter by last_connect (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_user]", "in" : "query", "description" : "Filter by last_user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locality_version]", "in" : "query", "description" : "Filter by locality_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobility_version]", "in" : "query", "description" : "Filter by mobility_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[operating_system]", "in" : "query", "description" : "Filter by operating_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[registered]", "in" : "query", "description" : "Filter by registered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_disconnect]", "in" : "query", "description" : "Filter by last_disconnect (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_category]", "in" : "query", "description" : "Filter by asset_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/NetmotionDevicesFields" }, { "$ref" : "#/components/parameters/NetmotionDevicesInclude" }, { "$ref" : "#/components/parameters/NetmotionDevicesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/NetmotionDevicesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/NetmotionDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a NetmotionDevices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NetmotionDevicesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/NetmotionDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/netmotionDevices/{id}/asset" : { "get" : { "description" : "Retrieve assets related to a netmotionDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NetmotionDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/netmotionDevices/{id}/relationships/asset" : { "get" : { "description" : "Retrieve assets references related to a netmotionDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NetmotionDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotifications/{id}" : { "get" : { "description" : "Retrieve a wfNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/WfNotificationsFields" }, { "$ref" : "#/components/parameters/WfNotificationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a WfNotifications", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/WfNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a WfNotifications", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WfNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotifications" : { "get" : { "description" : "Retrieve a List of wfNotifications resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[process_id]", "in" : "query", "description" : "Filter by process_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[step_id]", "in" : "query", "description" : "Filter by step_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idType]", "in" : "query", "description" : "Filter by idType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_column_table]", "in" : "query", "description" : "Filter by id_column_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_name]", "in" : "query", "description" : "Filter by activity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[text]", "in" : "query", "description" : "Filter by text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[next_step_url]", "in" : "query", "description" : "Filter by next_step_url (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idvalue]", "in" : "query", "description" : "Filter by idvalue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[result]", "in" : "query", "description" : "Filter by result (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remarks]", "in" : "query", "description" : "Filter by remarks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotificationsArchives]", "in" : "query", "description" : "Filter by wfNotificationsArchives (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WfNotificationsFields" }, { "$ref" : "#/components/parameters/WfNotificationsInclude" }, { "$ref" : "#/components/parameters/WfNotificationsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a WfNotifications", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WfNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotifications/{id}/wfNotificationsArchives" : { "get" : { "description" : "Retrieve wfNotificationsArchives related to a wfNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notification_id]", "in" : "query", "description" : "Filter by notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[process_id]", "in" : "query", "description" : "Filter by process_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[step_id]", "in" : "query", "description" : "Filter by step_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idType]", "in" : "query", "description" : "Filter by idType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_column_table]", "in" : "query", "description" : "Filter by id_column_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_name]", "in" : "query", "description" : "Filter by activity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[text]", "in" : "query", "description" : "Filter by text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[next_step_url]", "in" : "query", "description" : "Filter by next_step_url (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idvalue]", "in" : "query", "description" : "Filter by idvalue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[result]", "in" : "query", "description" : "Filter by result (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remarks]", "in" : "query", "description" : "Filter by remarks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[archive_date]", "in" : "query", "description" : "Filter by archive_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WfNotificationsArchivesFields" }, { "$ref" : "#/components/parameters/WfNotificationsArchivesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotifications/{id}/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates related to a wfNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotifications/{id}/relationships/wfNotificationsArchives" : { "get" : { "description" : "Retrieve wfNotificationsArchives references related to a wfNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notification_id]", "in" : "query", "description" : "Filter by notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[process_id]", "in" : "query", "description" : "Filter by process_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[step_id]", "in" : "query", "description" : "Filter by step_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idType]", "in" : "query", "description" : "Filter by idType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_column_table]", "in" : "query", "description" : "Filter by id_column_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_name]", "in" : "query", "description" : "Filter by activity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[text]", "in" : "query", "description" : "Filter by text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[next_step_url]", "in" : "query", "description" : "Filter by next_step_url (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idvalue]", "in" : "query", "description" : "Filter by idvalue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[result]", "in" : "query", "description" : "Filter by result (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remarks]", "in" : "query", "description" : "Filter by remarks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[archive_date]", "in" : "query", "description" : "Filter by archive_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WfNotificationsArchivesFields" }, { "$ref" : "#/components/parameters/WfNotificationsArchivesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotifications/{id}/relationships/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates references related to a wfNotifications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimPayees/{id}" : { "get" : { "description" : "Retrieve a claimPayees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimPayeesPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimPayeesFields" }, { "$ref" : "#/components/parameters/ClaimPayeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimPayeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimPayeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ClaimPayees", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimPayeesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ClaimPayeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ClaimPayees", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimPayeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimPayeesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimPayeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimPayees" : { "get" : { "description" : "Retrieve a List of claimPayees resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_name]", "in" : "query", "description" : "Filter by first_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_name]", "in" : "query", "description" : "Filter by last_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimPayeesFields" }, { "$ref" : "#/components/parameters/ClaimPayeesInclude" }, { "$ref" : "#/components/parameters/ClaimPayeesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimPayeesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimPayeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ClaimPayees", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimPayeesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimPayeesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimPayeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimPayees/{id}/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers related to a claimPayees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimPayeesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimPayees/{id}/relationships/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers references related to a claimPayees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimPayeesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/wirelessInventories/{id}" : { "get" : { "description" : "Retrieve a wirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/WirelessInventoriesFields" }, { "$ref" : "#/components/parameters/WirelessInventoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WirelessInventoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a WirelessInventories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a WirelessInventories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WirelessInventoriesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/wirelessInventories" : { "get" : { "description" : "Retrieve a List of wirelessInventories resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_number]", "in" : "query", "description" : "Filter by wireless_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_vendor]", "in" : "query", "description" : "Filter by wireless_vendor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_full_name]", "in" : "query", "description" : "Filter by wireless_user_full_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_status]", "in" : "query", "description" : "Filter by wireless_user_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[truck_vin]", "in" : "query", "description" : "Filter by truck_vin (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imei]", "in" : "query", "description" : "Filter by imei (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sim_number]", "in" : "query", "description" : "Filter by sim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_model]", "in" : "query", "description" : "Filter by device_model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_end_date]", "in" : "query", "description" : "Filter by contract_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_usage]", "in" : "query", "description" : "Filter by data_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voice_usage]", "in" : "query", "description" : "Filter by voice_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[text_usage]", "in" : "query", "description" : "Filter by text_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[total_charges]", "in" : "query", "description" : "Filter by total_charges (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_last_updated_on]", "in" : "query", "description" : "Filter by device_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_last_updated_on]", "in" : "query", "description" : "Filter by usage_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesFields" }, { "$ref" : "#/components/parameters/WirelessInventoriesInclude" }, { "$ref" : "#/components/parameters/WirelessInventoriesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WirelessInventoriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a WirelessInventories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WirelessInventoriesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/wirelessInventories/{id}/dist" : { "get" : { "description" : "Retrieve districts related to a wirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/wirelessInventories/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a wirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/wirelessInventories/{id}/employeeOnLoan" : { "get" : { "description" : "Retrieve employeesOnLoan related to a wirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/wirelessInventories/{id}/relationships/dist" : { "get" : { "description" : "Retrieve districts references related to a wirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/wirelessInventories/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a wirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/wirelessInventories/{id}/relationships/employeeOnLoan" : { "get" : { "description" : "Retrieve employeesOnLoan references related to a wirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets/{id}" : { "get" : { "description" : "Retrieve a employeesActiveMultipleItAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a EmployeesActiveMultipleItAssets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a EmployeesActiveMultipleItAssets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets" : { "get" : { "description" : "Retrieve a List of employeesActiveMultipleItAssets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action]", "in" : "query", "description" : "Filter by action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimated_return_date]", "in" : "query", "description" : "Filter by estimated_return_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsInclude" }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a EmployeesActiveMultipleItAssets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeesActiveMultipleItAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/dist" : { "get" : { "description" : "Retrieve districts related to a employeesActiveMultipleItAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups related to a employeesActiveMultipleItAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/vehicles" : { "get" : { "description" : "Retrieve vehicles related to a employeesActiveMultipleItAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cvn]", "in" : "query", "description" : "Filter by cvn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_year]", "in" : "query", "description" : "Filter by model_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make]", "in" : "query", "description" : "Filter by make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_group]", "in" : "query", "description" : "Filter by model_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vin_number]", "in" : "query", "description" : "Filter by vin_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[license_plate_number]", "in" : "query", "description" : "Filter by license_plate_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/assetAssignments" : { "get" : { "description" : "Retrieve assetAssignments related to a employeesActiveMultipleItAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/relationships/dist" : { "get" : { "description" : "Retrieve districts references related to a employeesActiveMultipleItAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/relationships/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups references related to a employeesActiveMultipleItAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/relationships/vehicles" : { "get" : { "description" : "Retrieve vehicles references related to a employeesActiveMultipleItAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cvn]", "in" : "query", "description" : "Filter by cvn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_year]", "in" : "query", "description" : "Filter by model_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make]", "in" : "query", "description" : "Filter by make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_group]", "in" : "query", "description" : "Filter by model_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vin_number]", "in" : "query", "description" : "Filter by vin_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[license_plate_number]", "in" : "query", "description" : "Filter by license_plate_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/relationships/assetAssignments" : { "get" : { "description" : "Retrieve assetAssignments references related to a employeesActiveMultipleItAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveMultipleItAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageListings/{id}" : { "get" : { "description" : "Retrieve a damageListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageListingsPrimaryKey" }, { "$ref" : "#/components/parameters/DamageListingsFields" }, { "$ref" : "#/components/parameters/DamageListingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageListingsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamageListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a DamageListings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageListingsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DamageListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DamageListings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageListingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageListingsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamageListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageListings" : { "get" : { "description" : "Retrieve a List of damageListings resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_notification_id]", "in" : "query", "description" : "Filter by dl_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_damage_id]", "in" : "query", "description" : "Filter by dl_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_add1]", "in" : "query", "description" : "Filter by dl_add1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_city]", "in" : "query", "description" : "Filter by dl_city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_abbrev]", "in" : "query", "description" : "Filter by dl_abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_damage_date_time]", "in" : "query", "description" : "Filter by dl_damage_date_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_excavator]", "in" : "query", "description" : "Filter by dl_excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_customer_id]", "in" : "query", "description" : "Filter by dl_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_account_number]", "in" : "query", "description" : "Filter by dl_account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_customer_claim_number]", "in" : "query", "description" : "Filter by dl_customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dl_duplicate_damage_id]", "in" : "query", "description" : "Filter by dl_duplicate_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[duplicateDamage]", "in" : "query", "description" : "Filter by duplicateDamage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DamageListingsFields" }, { "$ref" : "#/components/parameters/DamageListingsInclude" }, { "$ref" : "#/components/parameters/DamageListingsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamageListingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DamageListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a DamageListings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageListingsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageListingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DamageListingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageListings/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a damageListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageListingsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageListings/{id}/duplicateDamage" : { "get" : { "description" : "Retrieve damages related to a damageListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageListingsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageListings/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a damageListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageListingsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/damageListings/{id}/relationships/duplicateDamage" : { "get" : { "description" : "Retrieve damages references related to a damageListings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DamageListingsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroups/{id}" : { "get" : { "description" : "Retrieve a reportGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/ReportGroupsFields" }, { "$ref" : "#/components/parameters/ReportGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ReportGroups", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ReportGroups", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroups" : { "get" : { "description" : "Retrieve a List of reportGroups resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[icon]", "in" : "query", "description" : "Filter by icon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkRoute]", "in" : "query", "description" : "Filter by linkRoute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[info]", "in" : "query", "description" : "Filter by info (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[num_columns]", "in" : "query", "description" : "Filter by num_columns (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportGroupSections]", "in" : "query", "description" : "Filter by reportGroupSections (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportGroupsFields" }, { "$ref" : "#/components/parameters/ReportGroupsInclude" }, { "$ref" : "#/components/parameters/ReportGroupsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ReportGroups", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroups/{id}/reportGroupSections" : { "get" : { "description" : "Retrieve reportGroupSections related to a reportGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_group_id]", "in" : "query", "description" : "Filter by report_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportGroup]", "in" : "query", "description" : "Filter by reportGroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reports]", "in" : "query", "description" : "Filter by reports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportsSectionOrders]", "in" : "query", "description" : "Filter by reportsSectionOrders (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsFields" }, { "$ref" : "#/components/parameters/ReportGroupSectionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportGroups relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportGroups relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportGroups relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroups/{id}/relationships/reportGroupSections" : { "get" : { "description" : "Retrieve reportGroupSections references related to a reportGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_group_id]", "in" : "query", "description" : "Filter by report_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportGroup]", "in" : "query", "description" : "Filter by reportGroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reports]", "in" : "query", "description" : "Filter by reports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportsSectionOrders]", "in" : "query", "description" : "Filter by reportsSectionOrders (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsFields" }, { "$ref" : "#/components/parameters/ReportGroupSectionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportGroups relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportGroups relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportGroups relationship to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userEmployeeAccesses/{id}" : { "get" : { "description" : "Retrieve a userEmployeeAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserEmployeeAccessesPrimaryKey" }, { "$ref" : "#/components/parameters/UserEmployeeAccessesFields" }, { "$ref" : "#/components/parameters/UserEmployeeAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserEmployeeAccessesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserEmployeeAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserEmployeeAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserEmployeeAccessesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserEmployeeAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserEmployeeAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserEmployeeAccessesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserEmployeeAccessesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserEmployeeAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/userEmployeeAccesses" : { "get" : { "description" : "Retrieve a List of userEmployeeAccesses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action]", "in" : "query", "description" : "Filter by action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimated_return_date]", "in" : "query", "description" : "Filter by estimated_return_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accessing_emp_id]", "in" : "query", "description" : "Filter by accessing_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserEmployeeAccessesFields" }, { "$ref" : "#/components/parameters/UserEmployeeAccessesInclude" }, { "$ref" : "#/components/parameters/UserEmployeeAccessesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserEmployeeAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserEmployeeAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserEmployeeAccesses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserEmployeeAccessesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserEmployeeAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}" : { "get" : { "description" : "Retrieve a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AttributeMappings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AttributeMappings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttributeMappingsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings" : { "get" : { "description" : "Retrieve a List of attributeMappings resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type_id]", "in" : "query", "description" : "Filter by asset_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" }, { "$ref" : "#/components/parameters/AttributeMappingsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AttributeMappings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttributeMappingsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttributeMappingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/assetAttribute" : { "get" : { "description" : "Retrieve assetAttributes related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAttributesFields" }, { "$ref" : "#/components/parameters/AssetAttributesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/assetType" : { "get" : { "description" : "Retrieve assetTypes related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetTypesFields" }, { "$ref" : "#/components/parameters/AssetTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/assetModel" : { "get" : { "description" : "Retrieve assetModels related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetModelsFields" }, { "$ref" : "#/components/parameters/AssetModelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/assetMake" : { "get" : { "description" : "Retrieve assetMakes related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetMakesFields" }, { "$ref" : "#/components/parameters/AssetMakesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/quickCode" : { "get" : { "description" : "Retrieve quickCodes related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodesFields" }, { "$ref" : "#/components/parameters/QuickCodesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/relationships/assetAttribute" : { "get" : { "description" : "Retrieve assetAttributes references related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAttributesFields" }, { "$ref" : "#/components/parameters/AssetAttributesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/relationships/assetType" : { "get" : { "description" : "Retrieve assetTypes references related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetTypesFields" }, { "$ref" : "#/components/parameters/AssetTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a assetTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/relationships/assetModel" : { "get" : { "description" : "Retrieve assetModels references related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetModelsFields" }, { "$ref" : "#/components/parameters/AssetModelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a assetModels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/relationships/assetMake" : { "get" : { "description" : "Retrieve assetMakes references related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetMakesFields" }, { "$ref" : "#/components/parameters/AssetMakesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attributeMappings/{id}/relationships/quickCode" : { "get" : { "description" : "Retrieve quickCodes references related to a attributeMappings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodesFields" }, { "$ref" : "#/components/parameters/QuickCodesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create attributeMappings relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete attributeMappings relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update attributeMappings relationship to a quickCodes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/userRoles/{id}" : { "get" : { "description" : "Retrieve a userRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRolesPrimaryKey" }, { "$ref" : "#/components/parameters/UserRolesFields" }, { "$ref" : "#/components/parameters/UserRolesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserRoles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRolesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserRoles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRolesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/userRoles" : { "get" : { "description" : "Retrieve a List of userRoles resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roleAccesses]", "in" : "query", "description" : "Filter by roleAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserRolesFields" }, { "$ref" : "#/components/parameters/UserRolesInclude" }, { "$ref" : "#/components/parameters/UserRolesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserRolesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserRoles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/userRoles/{id}/roleAccesses" : { "get" : { "description" : "Retrieve roleAccesses related to a userRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRolesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[role_id]", "in" : "query", "description" : "Filter by role_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action_id]", "in" : "query", "description" : "Filter by action_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_add]", "in" : "query", "description" : "Filter by p_add (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_delete]", "in" : "query", "description" : "Filter by p_delete (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_edit]", "in" : "query", "description" : "Filter by p_edit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_view]", "in" : "query", "description" : "Filter by p_view (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userRole]", "in" : "query", "description" : "Filter by userRole (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roleAction]", "in" : "query", "description" : "Filter by roleAction (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RoleAccessesFields" }, { "$ref" : "#/components/parameters/RoleAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/userRoles/{id}/relationships/roleAccesses" : { "get" : { "description" : "Retrieve roleAccesses references related to a userRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserRolesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[role_id]", "in" : "query", "description" : "Filter by role_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action_id]", "in" : "query", "description" : "Filter by action_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_add]", "in" : "query", "description" : "Filter by p_add (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_delete]", "in" : "query", "description" : "Filter by p_delete (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_edit]", "in" : "query", "description" : "Filter by p_edit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[p_view]", "in" : "query", "description" : "Filter by p_view (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userRole]", "in" : "query", "description" : "Filter by userRole (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roleAction]", "in" : "query", "description" : "Filter by roleAction (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RoleAccessesFields" }, { "$ref" : "#/components/parameters/RoleAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/RoleAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userContacts/{id}" : { "get" : { "description" : "Retrieve a userContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserContactsPrimaryKey" }, { "$ref" : "#/components/parameters/UserContactsFields" }, { "$ref" : "#/components/parameters/UserContactsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserContactsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserContacts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserContactsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserContacts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserContactsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserContactsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userContacts" : { "get" : { "description" : "Retrieve a List of userContacts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_name]", "in" : "query", "description" : "Filter by cp_user_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_district_code]", "in" : "query", "description" : "Filter by cp_district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_district_abbr]", "in" : "query", "description" : "Filter by cp_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_district_name]", "in" : "query", "description" : "Filter by cp_district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_contact_id]", "in" : "query", "description" : "Filter by usic_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_state]", "in" : "query", "description" : "Filter by district_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line1]", "in" : "query", "description" : "Filter by address_line1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line2]", "in" : "query", "description" : "Filter by address_line2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line3]", "in" : "query", "description" : "Filter by address_line3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_name]", "in" : "query", "description" : "Filter by dm_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_email]", "in" : "query", "description" : "Filter by dm_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_phone_no]", "in" : "query", "description" : "Filter by dm_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr]", "in" : "query", "description" : "Filter by hr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr_phone_no]", "in" : "query", "description" : "Filter by hr_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_name]", "in" : "query", "description" : "Filter by rd_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_phone_no]", "in" : "query", "description" : "Filter by rd_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_email]", "in" : "query", "description" : "Filter by rd_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[it_support]", "in" : "query", "description" : "Filter by it_support (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[it_support_phone_no]", "in" : "query", "description" : "Filter by it_support_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_contact]", "in" : "query", "description" : "Filter by sales_contact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_phone_no]", "in" : "query", "description" : "Filter by sales_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_email]", "in" : "query", "description" : "Filter by sales_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_contact]", "in" : "query", "description" : "Filter by general_contact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_phone_no]", "in" : "query", "description" : "Filter by general_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_email]", "in" : "query", "description" : "Filter by general_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserContactsFields" }, { "$ref" : "#/components/parameters/UserContactsInclude" }, { "$ref" : "#/components/parameters/UserContactsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserContactsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserContacts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserContactsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserContactsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}" : { "get" : { "description" : "Retrieve a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Investigations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Investigations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations" : { "get" : { "description" : "Retrieve a List of investigations resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavationType]", "in" : "query", "description" : "Filter by excavationType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavat]", "in" : "query", "description" : "Filter by excavat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetails]", "in" : "query", "description" : "Filter by investigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersions]", "in" : "query", "description" : "Filter by investigationVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetails]", "in" : "query", "description" : "Filter by cmsInvestigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenEmployee]", "in" : "query", "description" : "Filter by picsTakenEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireAnswers]", "in" : "query", "description" : "Filter by questionnaireAnswers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" }, { "$ref" : "#/components/parameters/InvestigationsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Investigations", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/excavationType" : { "get" : { "description" : "Retrieve quickCodeValue related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/excavat" : { "get" : { "description" : "Retrieve excavator related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/ExcavatorFields" }, { "$ref" : "#/components/parameters/ExcavatorInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ExcavatorResourceResponse" }, "202" : { "$ref" : "#/components/responses/ExcavatorResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/investigationDetails" : { "get" : { "description" : "Retrieve investigationDetails related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_investigation_id]", "in" : "query", "description" : "Filter by id_investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_notification_id]", "in" : "query", "description" : "Filter by id_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_damage_id]", "in" : "query", "description" : "Filter by id_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_customer_id]", "in" : "query", "description" : "Filter by id_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_account_level_customer_id]", "in" : "query", "description" : "Filter by id_account_level_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_damage_customer]", "in" : "query", "description" : "Filter by id_damage_customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_utility]", "in" : "query", "description" : "Filter by id_utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility]", "in" : "query", "description" : "Filter by id_facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility_type]", "in" : "query", "description" : "Filter by id_facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_locator_name]", "in" : "query", "description" : "Filter by id_locator_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_cause_factor]", "in" : "query", "description" : "Filter by id_cause_factor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_were_markings_visible]", "in" : "query", "description" : "Filter by id_were_markings_visible (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_other_indicators]", "in" : "query", "description" : "Filter by id_other_indicators (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_tolerence_zone]", "in" : "query", "description" : "Filter by id_tolerence_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility_damage]", "in" : "query", "description" : "Filter by id_facility_damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_replacement_footage]", "in" : "query", "description" : "Filter by id_replacement_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_contractor_assistance]", "in" : "query", "description" : "Filter by id_contractor_assistance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_contractor_equipment]", "in" : "query", "description" : "Filter by id_contractor_equipment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility_shown]", "in" : "query", "description" : "Filter by id_facility_shown (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_record_numbers]", "in" : "query", "description" : "Filter by id_record_numbers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_report_attachment_id]", "in" : "query", "description" : "Filter by inv_report_attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationReport]", "in" : "query", "description" : "Filter by investigationReport (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/investigationDetailsVersions" : { "get" : { "description" : "Retrieve investigationDetailsVersions related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersion]", "in" : "query", "description" : "Filter by investigationVersion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completedBy]", "in" : "query", "description" : "Filter by completedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changedBy]", "in" : "query", "description" : "Filter by changedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/investigationVersions" : { "get" : { "description" : "Retrieve investigationVersions related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approverEmployee]", "in" : "query", "description" : "Filter by approverEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenByEmployee]", "in" : "query", "description" : "Filter by picsTakenByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationVersionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/cmsInvestigationDetails" : { "get" : { "description" : "Retrieve cmsInvestigationDetails related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor_id]", "in" : "query", "description" : "Filter by supervisor_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[event_summary]", "in" : "query", "description" : "Filter by event_summary (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[video_url]", "in" : "query", "description" : "Filter by video_url (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_report_attachment_id]", "in" : "query", "description" : "Filter by inv_report_attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailLines]", "in" : "query", "description" : "Filter by investigationDetailLines (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationReport]", "in" : "query", "description" : "Filter by investigationReport (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utilitiesProfilesView]", "in" : "query", "description" : "Filter by utilitiesProfilesView (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/picsTakenEmployee" : { "get" : { "description" : "Retrieve employees related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/questionnaireAnswers" : { "get" : { "description" : "Retrieve questionnaireAnswers related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[question_id]", "in" : "query", "description" : "Filter by question_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[answer]", "in" : "query", "description" : "Filter by answer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireQuestion]", "in" : "query", "description" : "Filter by questionnaireQuestion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersFields" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/estimates" : { "get" : { "description" : "Retrieve estimates related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/excavationType" : { "get" : { "description" : "Retrieve quickCodeValue references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/excavat" : { "get" : { "description" : "Retrieve excavator references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/ExcavatorFields" }, { "$ref" : "#/components/parameters/ExcavatorInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ExcavatorResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ExcavatorResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/investigationDetails" : { "get" : { "description" : "Retrieve investigationDetails references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_investigation_id]", "in" : "query", "description" : "Filter by id_investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_notification_id]", "in" : "query", "description" : "Filter by id_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_damage_id]", "in" : "query", "description" : "Filter by id_damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_customer_id]", "in" : "query", "description" : "Filter by id_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_account_level_customer_id]", "in" : "query", "description" : "Filter by id_account_level_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_damage_customer]", "in" : "query", "description" : "Filter by id_damage_customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_utility]", "in" : "query", "description" : "Filter by id_utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility]", "in" : "query", "description" : "Filter by id_facility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility_type]", "in" : "query", "description" : "Filter by id_facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_locator_name]", "in" : "query", "description" : "Filter by id_locator_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_cause_factor]", "in" : "query", "description" : "Filter by id_cause_factor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_were_markings_visible]", "in" : "query", "description" : "Filter by id_were_markings_visible (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_other_indicators]", "in" : "query", "description" : "Filter by id_other_indicators (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_tolerence_zone]", "in" : "query", "description" : "Filter by id_tolerence_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility_damage]", "in" : "query", "description" : "Filter by id_facility_damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_replacement_footage]", "in" : "query", "description" : "Filter by id_replacement_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_contractor_assistance]", "in" : "query", "description" : "Filter by id_contractor_assistance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_contractor_equipment]", "in" : "query", "description" : "Filter by id_contractor_equipment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_facility_shown]", "in" : "query", "description" : "Filter by id_facility_shown (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_record_numbers]", "in" : "query", "description" : "Filter by id_record_numbers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_report_attachment_id]", "in" : "query", "description" : "Filter by inv_report_attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationReport]", "in" : "query", "description" : "Filter by investigationReport (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/investigationDetailsVersions" : { "get" : { "description" : "Retrieve investigationDetailsVersions references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersion]", "in" : "query", "description" : "Filter by investigationVersion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completedBy]", "in" : "query", "description" : "Filter by completedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changedBy]", "in" : "query", "description" : "Filter by changedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/investigationVersions" : { "get" : { "description" : "Retrieve investigationVersions references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approverEmployee]", "in" : "query", "description" : "Filter by approverEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenByEmployee]", "in" : "query", "description" : "Filter by picsTakenByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/cmsInvestigationDetails" : { "get" : { "description" : "Retrieve cmsInvestigationDetails references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor_id]", "in" : "query", "description" : "Filter by supervisor_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[event_summary]", "in" : "query", "description" : "Filter by event_summary (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[video_url]", "in" : "query", "description" : "Filter by video_url (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_report_attachment_id]", "in" : "query", "description" : "Filter by inv_report_attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailLines]", "in" : "query", "description" : "Filter by investigationDetailLines (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationReport]", "in" : "query", "description" : "Filter by investigationReport (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utilitiesProfilesView]", "in" : "query", "description" : "Filter by utilitiesProfilesView (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/picsTakenEmployee" : { "get" : { "description" : "Retrieve employees references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/questionnaireAnswers" : { "get" : { "description" : "Retrieve questionnaireAnswers references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[question_id]", "in" : "query", "description" : "Filter by question_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[answer]", "in" : "query", "description" : "Filter by answer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireQuestion]", "in" : "query", "description" : "Filter by questionnaireQuestion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuestionnaireAnswersFields" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/policyDropOffEstimates" : { "get" : { "description" : "Retrieve policyDropOffEstimates references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesFields" }, { "$ref" : "#/components/parameters/PolicyDropOffEstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/PolicyDropOffEstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigations/{id}/relationships/estimates" : { "get" : { "description" : "Retrieve estimates references related to a investigations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accrualSummaries/{id}" : { "get" : { "description" : "Retrieve a accrualSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/AccrualSummariesFields" }, { "$ref" : "#/components/parameters/AccrualSummariesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualSummariesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AccrualSummaries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AccrualSummaries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualSummariesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accrualSummaries" : { "get" : { "description" : "Retrieve a List of accrualSummaries resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_type]", "in" : "query", "description" : "Filter by accrual_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[beginning_balance]", "in" : "query", "description" : "Filter by beginning_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ending_balance]", "in" : "query", "description" : "Filter by ending_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_amount]", "in" : "query", "description" : "Filter by period_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[current_flag]", "in" : "query", "description" : "Filter by current_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesFields" }, { "$ref" : "#/components/parameters/AccrualSummariesInclude" }, { "$ref" : "#/components/parameters/AccrualSummariesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AccrualSummariesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AccrualSummaries", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualSummariesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualSummariesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AccrualSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accrualSummaries/{id}/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods related to a accrualSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accrualSummaries/{id}/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests related to a accrualSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accrualSummaries/{id}/district" : { "get" : { "description" : "Retrieve districts related to a accrualSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accrualSummaries/{id}/relationships/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods references related to a accrualSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accrualSummaries/{id}/relationships/cmsRequest" : { "get" : { "description" : "Retrieve cmsRequests references related to a accrualSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/CmsRequestsFields" }, { "$ref" : "#/components/parameters/CmsRequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsRequestsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsRequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/accrualSummaries/{id}/relationships/district" : { "get" : { "description" : "Retrieve districts references related to a accrualSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AccrualSummariesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/statusesCode/{id}" : { "get" : { "description" : "Retrieve a statusesCode resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesCodePrimaryKey" }, { "$ref" : "#/components/parameters/StatusesCodeFields" }, { "$ref" : "#/components/parameters/StatusesCodeInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesCodeResourceResponse" }, "202" : { "$ref" : "#/components/responses/StatusesCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a StatusesCode", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesCodePrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/StatusesCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a StatusesCode", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesCodePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesCodePatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/StatusesCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/statusesCode" : { "get" : { "description" : "Retrieve a List of statusesCode resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category]", "in" : "query", "description" : "Filter by category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[on_site]", "in" : "query", "description" : "Filter by on_site (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notify_excavator]", "in" : "query", "description" : "Filter by notify_excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[next_status_id]", "in" : "query", "description" : "Filter by next_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deleted]", "in" : "query", "description" : "Filter by deleted (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reschedule]", "in" : "query", "description" : "Filter by reschedule (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[screening]", "in" : "query", "description" : "Filter by screening (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/StatusesCodeFields" }, { "$ref" : "#/components/parameters/StatusesCodeInclude" }, { "$ref" : "#/components/parameters/StatusesCodeSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StatusesCodeResourcesResponse" }, "202" : { "$ref" : "#/components/responses/StatusesCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a StatusesCode", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesCodePostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesCodeResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/StatusesCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/statusesCode/{id}/activities" : { "get" : { "description" : "Retrieve activities related to a statusesCode resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesCodePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/statusesCode/{id}/relationships/activities" : { "get" : { "description" : "Retrieve activities references related to a statusesCode resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StatusesCodePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDiscounts/{id}" : { "get" : { "description" : "Retrieve a claimDiscounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDiscountsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimDiscountsFields" }, { "$ref" : "#/components/parameters/ClaimDiscountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDiscountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDiscountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ClaimDiscounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDiscountsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ClaimDiscountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ClaimDiscounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDiscountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDiscountsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimDiscountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDiscounts" : { "get" : { "description" : "Retrieve a List of claimDiscounts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[discount_reason]", "in" : "query", "description" : "Filter by discount_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[discount_amount]", "in" : "query", "description" : "Filter by discount_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDiscountsFields" }, { "$ref" : "#/components/parameters/ClaimDiscountsInclude" }, { "$ref" : "#/components/parameters/ClaimDiscountsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDiscountsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDiscountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ClaimDiscounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDiscountsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimDiscountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDiscounts/{id}/claim" : { "get" : { "description" : "Retrieve claims related to a claimDiscounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDiscountsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimDiscounts/{id}/relationships/claim" : { "get" : { "description" : "Retrieve claims references related to a claimDiscounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimDiscountsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/violationStatuses/{id}" : { "get" : { "description" : "Retrieve a violationStatuses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ViolationStatusesPrimaryKey" }, { "$ref" : "#/components/parameters/ViolationStatusesFields" }, { "$ref" : "#/components/parameters/ViolationStatusesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ViolationStatusesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ViolationStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ViolationStatuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ViolationStatusesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ViolationStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ViolationStatuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ViolationStatusesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ViolationStatusesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ViolationStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/violationStatuses" : { "get" : { "description" : "Retrieve a List of violationStatuses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category]", "in" : "query", "description" : "Filter by category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_order]", "in" : "query", "description" : "Filter by display_order (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ViolationStatusesFields" }, { "$ref" : "#/components/parameters/ViolationStatusesInclude" }, { "$ref" : "#/components/parameters/ViolationStatusesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ViolationStatusesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ViolationStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ViolationStatuses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ViolationStatusesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ViolationStatusesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ViolationStatusesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/mdmDevices/{id}" : { "get" : { "description" : "Retrieve a mdmDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MdmDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/MdmDevicesFields" }, { "$ref" : "#/components/parameters/MdmDevicesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MdmDevicesResourceResponse" }, "202" : { "$ref" : "#/components/responses/MdmDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a MdmDevices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MdmDevicesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/MdmDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a MdmDevices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MdmDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MdmDevicesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/MdmDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/mdmDevices" : { "get" : { "description" : "Retrieve a List of mdmDevices resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[device_group]", "in" : "query", "description" : "Filter by device_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[username]", "in" : "query", "description" : "Filter by username (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[network]", "in" : "query", "description" : "Filter by network (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone_number]", "in" : "query", "description" : "Filter by phone_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[iccid]", "in" : "query", "description" : "Filter by iccid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_name]", "in" : "query", "description" : "Filter by device_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model]", "in" : "query", "description" : "Filter by model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/MdmDevicesFields" }, { "$ref" : "#/components/parameters/MdmDevicesInclude" }, { "$ref" : "#/components/parameters/MdmDevicesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MdmDevicesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/MdmDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a MdmDevices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MdmDevicesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MdmDevicesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/MdmDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/mdmDevices/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a mdmDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MdmDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/mdmDevices/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a mdmDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MdmDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroupSections/{id}" : { "get" : { "description" : "Retrieve a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" }, { "$ref" : "#/components/parameters/ReportGroupSectionsFields" }, { "$ref" : "#/components/parameters/ReportGroupSectionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ReportGroupSections", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ReportGroupSections", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroupSections" : { "get" : { "description" : "Retrieve a List of reportGroupSections resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_group_id]", "in" : "query", "description" : "Filter by report_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportGroup]", "in" : "query", "description" : "Filter by reportGroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reports]", "in" : "query", "description" : "Filter by reports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportsSectionOrders]", "in" : "query", "description" : "Filter by reportsSectionOrders (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsFields" }, { "$ref" : "#/components/parameters/ReportGroupSectionsInclude" }, { "$ref" : "#/components/parameters/ReportGroupSectionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupSectionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ReportGroupSections", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportGroupSectionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroupSections/{id}/reportGroup" : { "get" : { "description" : "Retrieve reportGroups related to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" }, { "$ref" : "#/components/parameters/ReportGroupsFields" }, { "$ref" : "#/components/parameters/ReportGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportGroupSections relationship to a reportGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportGroupSections relationship to a reportGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportGroupSections relationship to a reportGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroupSections/{id}/reports" : { "get" : { "description" : "Retrieve reports related to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_source_id]", "in" : "query", "description" : "Filter by report_source_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_type]", "in" : "query", "description" : "Filter by report_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model]", "in" : "query", "description" : "Filter by model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sql]", "in" : "query", "description" : "Filter by sql (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[params]", "in" : "query", "description" : "Filter by params (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[columns]", "in" : "query", "description" : "Filter by columns (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportSource]", "in" : "query", "description" : "Filter by reportSource (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportsFields" }, { "$ref" : "#/components/parameters/ReportsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroupSections/{id}/reportsSectionOrders" : { "get" : { "description" : "Retrieve reportsSectionOrders related to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_group_section_id]", "in" : "query", "description" : "Filter by report_group_section_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_id]", "in" : "query", "description" : "Filter by report_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq]", "in" : "query", "description" : "Filter by seq (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportGroupSection]", "in" : "query", "description" : "Filter by reportGroupSection (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report]", "in" : "query", "description" : "Filter by report (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersFields" }, { "$ref" : "#/components/parameters/ReportsSectionOrdersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportGroupSections relationship to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportGroupSections relationship to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportGroupSections relationship to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroupSections/{id}/relationships/reportGroup" : { "get" : { "description" : "Retrieve reportGroups references related to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" }, { "$ref" : "#/components/parameters/ReportGroupsFields" }, { "$ref" : "#/components/parameters/ReportGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportGroupSections relationship to a reportGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportGroupSections relationship to a reportGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportGroupSections relationship to a reportGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroupSections/{id}/relationships/reports" : { "get" : { "description" : "Retrieve reports references related to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_source_id]", "in" : "query", "description" : "Filter by report_source_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_type]", "in" : "query", "description" : "Filter by report_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model]", "in" : "query", "description" : "Filter by model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sql]", "in" : "query", "description" : "Filter by sql (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[params]", "in" : "query", "description" : "Filter by params (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[columns]", "in" : "query", "description" : "Filter by columns (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportSource]", "in" : "query", "description" : "Filter by reportSource (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportsFields" }, { "$ref" : "#/components/parameters/ReportsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportGroupSections/{id}/relationships/reportsSectionOrders" : { "get" : { "description" : "Retrieve reportsSectionOrders references related to a reportGroupSections resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_group_section_id]", "in" : "query", "description" : "Filter by report_group_section_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_id]", "in" : "query", "description" : "Filter by report_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq]", "in" : "query", "description" : "Filter by seq (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportGroupSection]", "in" : "query", "description" : "Filter by reportGroupSection (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report]", "in" : "query", "description" : "Filter by report (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportsSectionOrdersFields" }, { "$ref" : "#/components/parameters/ReportsSectionOrdersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportGroupSections relationship to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportGroupSections relationship to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportGroupSections relationship to a reportsSectionOrders resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportGroupSectionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsSectionOrdersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessageLogs/{id}" : { "get" : { "description" : "Retrieve a smsMessageLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" }, { "$ref" : "#/components/parameters/SmsMessageLogsFields" }, { "$ref" : "#/components/parameters/SmsMessageLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessageLogsResourceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessageLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a SmsMessageLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/SmsMessageLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a SmsMessageLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessageLogsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SmsMessageLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessageLogs" : { "get" : { "description" : "Retrieve a List of smsMessageLogs resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_id]", "in" : "query", "description" : "Filter by device_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_code]", "in" : "query", "description" : "Filter by status_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[smsMessage]", "in" : "query", "description" : "Filter by smsMessage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsFields" }, { "$ref" : "#/components/parameters/SmsMessageLogsInclude" }, { "$ref" : "#/components/parameters/SmsMessageLogsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessageLogsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessageLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a SmsMessageLogs", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessageLogsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SmsMessageLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessageLogs/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a smsMessageLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessageLogs/{id}/smsMessage" : { "get" : { "description" : "Retrieve smsMessages related to a smsMessageLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" }, { "$ref" : "#/components/parameters/SmsMessagesFields" }, { "$ref" : "#/components/parameters/SmsMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create smsMessageLogs relationship to a smsMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete smsMessageLogs relationship to a smsMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update smsMessageLogs relationship to a smsMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessageLogs/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a smsMessageLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessageLogs/{id}/relationships/smsMessage" : { "get" : { "description" : "Retrieve smsMessages references related to a smsMessageLogs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" }, { "$ref" : "#/components/parameters/SmsMessagesFields" }, { "$ref" : "#/components/parameters/SmsMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create smsMessageLogs relationship to a smsMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete smsMessageLogs relationship to a smsMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update smsMessageLogs relationship to a smsMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventorySfos/{id}" : { "get" : { "description" : "Retrieve a verizonWirelessInventorySfos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a VerizonWirelessInventorySfos", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a VerizonWirelessInventorySfos", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventorySfos" : { "get" : { "description" : "Retrieve a List of verizonWirelessInventorySfos resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mdn]", "in" : "query", "description" : "Filter by mdn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sfo_code]", "in" : "query", "description" : "Filter by sfo_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sfo_description]", "in" : "query", "description" : "Filter by sfo_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[verizonWirelessInventory]", "in" : "query", "description" : "Filter by verizonWirelessInventory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosInclude" }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a VerizonWirelessInventorySfos", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventorySfosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventorySfos/{id}/verizonWirelessInventory" : { "get" : { "description" : "Retrieve verizonWirelessInventories related to a verizonWirelessInventorySfos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create verizonWirelessInventorySfos relationship to a verizonWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete verizonWirelessInventorySfos relationship to a verizonWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update verizonWirelessInventorySfos relationship to a verizonWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventorySfos/{id}/relationships/verizonWirelessInventory" : { "get" : { "description" : "Retrieve verizonWirelessInventories references related to a verizonWirelessInventorySfos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create verizonWirelessInventorySfos relationship to a verizonWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete verizonWirelessInventorySfos relationship to a verizonWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update verizonWirelessInventorySfos relationship to a verizonWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventorySfosPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportDataTypes/{id}" : { "get" : { "description" : "Retrieve a reportDataTypes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportDataTypesPrimaryKey" }, { "$ref" : "#/components/parameters/ReportDataTypesFields" }, { "$ref" : "#/components/parameters/ReportDataTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportDataTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportDataTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ReportDataTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportDataTypesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ReportDataTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ReportDataTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportDataTypesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportDataTypesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportDataTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportDataTypes" : { "get" : { "description" : "Retrieve a List of reportDataTypes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[database_name]", "in" : "query", "description" : "Filter by database_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[table_name]", "in" : "query", "description" : "Filter by table_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value_attribute]", "in" : "query", "description" : "Filter by value_attribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[qualifier]", "in" : "query", "description" : "Filter by qualifier (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_source]", "in" : "query", "description" : "Filter by data_source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_name]", "in" : "query", "description" : "Filter by model_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filter_json]", "in" : "query", "description" : "Filter by filter_json (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[label]", "in" : "query", "description" : "Filter by label (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ui_value]", "in" : "query", "description" : "Filter by ui_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ui_option]", "in" : "query", "description" : "Filter by ui_option (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ui_option_custom]", "in" : "query", "description" : "Filter by ui_option_custom (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportDataTypesFields" }, { "$ref" : "#/components/parameters/ReportDataTypesInclude" }, { "$ref" : "#/components/parameters/ReportDataTypesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportDataTypesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportDataTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ReportDataTypes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportDataTypesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportDataTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportDataTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/requests/{id}" : { "get" : { "description" : "Retrieve a requests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RequestsPrimaryKey" }, { "$ref" : "#/components/parameters/RequestsFields" }, { "$ref" : "#/components/parameters/RequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourceResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Requests", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RequestsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Requests", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RequestsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/requests" : { "get" : { "description" : "Retrieve a List of requests resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userid]", "in" : "query", "description" : "Filter by userid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[username]", "in" : "query", "description" : "Filter by username (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[session_id]", "in" : "query", "description" : "Filter by session_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_time]", "in" : "query", "description" : "Filter by start_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_time]", "in" : "query", "description" : "Filter by end_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_name]", "in" : "query", "description" : "Filter by request_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_type]", "in" : "query", "description" : "Filter by request_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_status]", "in" : "query", "description" : "Filter by completed_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param1]", "in" : "query", "description" : "Filter by param1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param2]", "in" : "query", "description" : "Filter by param2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param3]", "in" : "query", "description" : "Filter by param3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param4]", "in" : "query", "description" : "Filter by param4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param5]", "in" : "query", "description" : "Filter by param5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param6]", "in" : "query", "description" : "Filter by param6 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param7]", "in" : "query", "description" : "Filter by param7 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param8]", "in" : "query", "description" : "Filter by param8 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param9]", "in" : "query", "description" : "Filter by param9 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param10]", "in" : "query", "description" : "Filter by param10 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RequestsFields" }, { "$ref" : "#/components/parameters/RequestsInclude" }, { "$ref" : "#/components/parameters/RequestsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Requests", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/requests/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a requests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RequestsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/requests/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a requests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/RequestsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/digAreas/{id}" : { "get" : { "description" : "Retrieve a digAreas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DigAreasPrimaryKey" }, { "$ref" : "#/components/parameters/DigAreasFields" }, { "$ref" : "#/components/parameters/DigAreasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DigAreasResourceResponse" }, "202" : { "$ref" : "#/components/responses/DigAreasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a DigAreas", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DigAreasPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DigAreasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DigAreas", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DigAreasPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DigAreasPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DigAreasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/digAreas" : { "get" : { "description" : "Retrieve a List of digAreas resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[order_number]", "in" : "query", "description" : "Filter by order_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[group_index]", "in" : "query", "description" : "Filter by group_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DigAreasFields" }, { "$ref" : "#/components/parameters/DigAreasInclude" }, { "$ref" : "#/components/parameters/DigAreasSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DigAreasResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DigAreasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a DigAreas", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DigAreasPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DigAreasResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DigAreasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/digAreas/{id}/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail related to a digAreas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DigAreasPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/digAreas/{id}/relationships/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail references related to a digAreas resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DigAreasPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileLevels/{id}" : { "get" : { "description" : "Retrieve a profileLevels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileLevelsPrimaryKey" }, { "$ref" : "#/components/parameters/ProfileLevelsFields" }, { "$ref" : "#/components/parameters/ProfileLevelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ProfileLevels", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileLevelsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ProfileLevels", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileLevelsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileLevels" : { "get" : { "description" : "Retrieve a List of profileLevels resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[level_number]", "in" : "query", "description" : "Filter by level_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profileValues]", "in" : "query", "description" : "Filter by profileValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ProfileLevelsFields" }, { "$ref" : "#/components/parameters/ProfileLevelsInclude" }, { "$ref" : "#/components/parameters/ProfileLevelsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileLevelsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ProfileLevels", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ProfileLevelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileLevels/{id}/profileValues" : { "get" : { "description" : "Retrieve profileValues related to a profileLevels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileLevelsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_id]", "in" : "query", "description" : "Filter by profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_level_id]", "in" : "query", "description" : "Filter by profile_level_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value_data_type]", "in" : "query", "description" : "Filter by value_data_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile]", "in" : "query", "description" : "Filter by profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profileLevel]", "in" : "query", "description" : "Filter by profileLevel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ProfileValuesFields" }, { "$ref" : "#/components/parameters/ProfileValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileValuesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/profileLevels/{id}/relationships/profileValues" : { "get" : { "description" : "Retrieve profileValues references related to a profileLevels resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProfileLevelsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_id]", "in" : "query", "description" : "Filter by profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile_level_id]", "in" : "query", "description" : "Filter by profile_level_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value_data_type]", "in" : "query", "description" : "Filter by value_data_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profile]", "in" : "query", "description" : "Filter by profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[profileLevel]", "in" : "query", "description" : "Filter by profileLevel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ProfileValuesFields" }, { "$ref" : "#/components/parameters/ProfileValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ProfileValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/utilities/{id}" : { "get" : { "description" : "Retrieve a utilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Utilities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilitiesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Utilities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/utilities" : { "get" : { "description" : "Retrieve a List of utilities resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[abbrev]", "in" : "query", "description" : "Filter by abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[office_id]", "in" : "query", "description" : "Filter by office_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[screen_bucket_id]", "in" : "query", "description" : "Filter by screen_bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_area]", "in" : "query", "description" : "Filter by require_area (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[app_key]", "in" : "query", "description" : "Filter by app_key (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[signature_requirement]", "in" : "query", "description" : "Filter by signature_requirement (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type]", "in" : "query", "description" : "Filter by facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_list_id]", "in" : "query", "description" : "Filter by service_list_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[auto_close]", "in" : "query", "description" : "Filter by auto_close (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_billing]", "in" : "query", "description" : "Filter by export_billing (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[has_gis_data]", "in" : "query", "description" : "Filter by has_gis_data (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_certificate]", "in" : "query", "description" : "Filter by require_certificate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_reschedule]", "in" : "query", "description" : "Filter by require_reschedule (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_eta]", "in" : "query", "description" : "Filter by require_eta (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[qc_bucket_id]", "in" : "query", "description" : "Filter by qc_bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[drawing_abbrev]", "in" : "query", "description" : "Filter by drawing_abbrev (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[proximity_code]", "in" : "query", "description" : "Filter by proximity_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_manual_time]", "in" : "query", "description" : "Filter by require_manual_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hp_scoring]", "in" : "query", "description" : "Filter by hp_scoring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclude_holdoff]", "in" : "query", "description" : "Filter by exclude_holdoff (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_academy_certificate]", "in" : "query", "description" : "Filter by require_academy_certificate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpCustomer]", "in" : "query", "description" : "Filter by tkpCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" }, { "$ref" : "#/components/parameters/UtilitiesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Utilities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/utilities/{id}/tkpCustomer" : { "get" : { "description" : "Retrieve tkpCustomers related to a utilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/TkpCustomersFields" }, { "$ref" : "#/components/parameters/TkpCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/utilities/{id}/relationships/tkpCustomer" : { "get" : { "description" : "Retrieve tkpCustomers references related to a utilities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UtilitiesPrimaryKey" }, { "$ref" : "#/components/parameters/TkpCustomersFields" }, { "$ref" : "#/components/parameters/TkpCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpCustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TkpCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccountNotes/{id}" : { "get" : { "description" : "Retrieve a customerAccountNotes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountNotesFields" }, { "$ref" : "#/components/parameters/CustomerAccountNotesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CustomerAccountNotes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CustomerAccountNotes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccountNotes" : { "get" : { "description" : "Retrieve a List of customerAccountNotes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[note]", "in" : "query", "description" : "Filter by note (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesFields" }, { "$ref" : "#/components/parameters/CustomerAccountNotesInclude" }, { "$ref" : "#/components/parameters/CustomerAccountNotesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CustomerAccountNotes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccountNotes/{id}/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts related to a customerAccountNotes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerAccountNotes relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerAccountNotes relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerAccountNotes relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccountNotes/{id}/relationships/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts references related to a customerAccountNotes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerAccountNotes relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerAccountNotes relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerAccountNotes relationship to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractSettings/{id}" : { "get" : { "description" : "Retrieve a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractSettingsFields" }, { "$ref" : "#/components/parameters/CustomerContractSettingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CustomerContractSettings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CustomerContractSettings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractSettings" : { "get" : { "description" : "Retrieve a List of customerContractSettings resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[theme]", "in" : "query", "description" : "Filter by theme (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filter_attachments]", "in" : "query", "description" : "Filter by filter_attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsFields" }, { "$ref" : "#/components/parameters/CustomerContractSettingsInclude" }, { "$ref" : "#/components/parameters/CustomerContractSettingsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CustomerContractSettings", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractSettings/{id}/customerContract" : { "get" : { "description" : "Retrieve customerContracts related to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractSettings/{id}/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts related to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractSettings/{id}/relationships/customerContract" : { "get" : { "description" : "Retrieve customerContracts references related to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractSettings/{id}/relationships/customerAccount" : { "get" : { "description" : "Retrieve customerAccounts references related to a customerContractSettings resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/projectTickets/{id}" : { "get" : { "description" : "Retrieve a projectTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProjectTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ProjectTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProjectTicketsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ProjectTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProjectTicketsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProjectTicketsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/projectTickets" : { "get" : { "description" : "Retrieve a List of projectTickets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[identified_by_id]", "in" : "query", "description" : "Filter by identified_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[identified_date]", "in" : "query", "description" : "Filter by identified_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" }, { "$ref" : "#/components/parameters/ProjectTicketsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ProjectTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProjectTicketsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProjectTicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/projectTickets/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a projectTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProjectTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/projectTickets/{id}/locates" : { "get" : { "description" : "Retrieve locates related to a projectTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProjectTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/projectTickets/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a projectTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProjectTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/projectTickets/{id}/relationships/locates" : { "get" : { "description" : "Retrieve locates references related to a projectTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ProjectTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/usicContacts/{id}" : { "get" : { "description" : "Retrieve a usicContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsicContactsPrimaryKey" }, { "$ref" : "#/components/parameters/UsicContactsFields" }, { "$ref" : "#/components/parameters/UsicContactsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UsicContacts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsicContactsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UsicContacts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsicContactsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/usicContacts" : { "get" : { "description" : "Retrieve a List of usicContacts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_state]", "in" : "query", "description" : "Filter by district_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line1]", "in" : "query", "description" : "Filter by address_line1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line2]", "in" : "query", "description" : "Filter by address_line2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line3]", "in" : "query", "description" : "Filter by address_line3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_name]", "in" : "query", "description" : "Filter by dm_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_email]", "in" : "query", "description" : "Filter by dm_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_phone_no]", "in" : "query", "description" : "Filter by dm_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr]", "in" : "query", "description" : "Filter by hr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr_phone_no]", "in" : "query", "description" : "Filter by hr_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_name]", "in" : "query", "description" : "Filter by rd_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_phone_no]", "in" : "query", "description" : "Filter by rd_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_email]", "in" : "query", "description" : "Filter by rd_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[it_support]", "in" : "query", "description" : "Filter by it_support (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[it_support_phone_no]", "in" : "query", "description" : "Filter by it_support_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_contact]", "in" : "query", "description" : "Filter by sales_contact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_phone_no]", "in" : "query", "description" : "Filter by sales_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_email]", "in" : "query", "description" : "Filter by sales_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_contact]", "in" : "query", "description" : "Filter by general_contact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_phone_no]", "in" : "query", "description" : "Filter by general_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_email]", "in" : "query", "description" : "Filter by general_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpDistrict]", "in" : "query", "description" : "Filter by cpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UsicContactsFields" }, { "$ref" : "#/components/parameters/UsicContactsInclude" }, { "$ref" : "#/components/parameters/UsicContactsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UsicContacts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/usicContacts/{id}/cpDistrict" : { "get" : { "description" : "Retrieve cpDistricts related to a usicContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsicContactsPrimaryKey" }, { "$ref" : "#/components/parameters/CpDistrictsFields" }, { "$ref" : "#/components/parameters/CpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CpDistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/usicContacts/{id}/relationships/cpDistrict" : { "get" : { "description" : "Retrieve cpDistricts references related to a usicContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsicContactsPrimaryKey" }, { "$ref" : "#/components/parameters/CpDistrictsFields" }, { "$ref" : "#/components/parameters/CpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CpDistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attWirelessInventories/{id}" : { "get" : { "description" : "Retrieve a attWirelessInventories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttWirelessInventoriesPrimaryKey" }, { "$ref" : "#/components/parameters/AttWirelessInventoriesFields" }, { "$ref" : "#/components/parameters/AttWirelessInventoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttWirelessInventoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AttWirelessInventories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttWirelessInventoriesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AttWirelessInventories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttWirelessInventoriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoriesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attWirelessInventories" : { "get" : { "description" : "Retrieve a List of attWirelessInventories resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[imei]", "in" : "query", "description" : "Filter by imei (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fan]", "in" : "query", "description" : "Filter by fan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ban]", "in" : "query", "description" : "Filter by ban (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_account_name]", "in" : "query", "description" : "Filter by billing_account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_status]", "in" : "query", "description" : "Filter by wireless_user_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_effective_date]", "in" : "query", "description" : "Filter by status_effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_full_name]", "in" : "query", "description" : "Filter by wireless_user_full_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_make]", "in" : "query", "description" : "Filter by device_make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_model]", "in" : "query", "description" : "Filter by device_model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_activation_date]", "in" : "query", "description" : "Filter by wireless_user_activation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_start_date]", "in" : "query", "description" : "Filter by contract_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_end_date]", "in" : "query", "description" : "Filter by contract_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_effective_date]", "in" : "query", "description" : "Filter by device_effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serivce_type]", "in" : "query", "description" : "Filter by serivce_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sim_number]", "in" : "query", "description" : "Filter by sim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sim_type]", "in" : "query", "description" : "Filter by sim_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rate_plan_name]", "in" : "query", "description" : "Filter by rate_plan_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[udl3]", "in" : "query", "description" : "Filter by udl3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[udl4]", "in" : "query", "description" : "Filter by udl4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[os_version]", "in" : "query", "description" : "Filter by os_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imeisv]", "in" : "query", "description" : "Filter by imeisv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[technology_type]", "in" : "query", "description" : "Filter by technology_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttWirelessInventoriesFields" }, { "$ref" : "#/components/parameters/AttWirelessInventoriesInclude" }, { "$ref" : "#/components/parameters/AttWirelessInventoriesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttWirelessInventoriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AttWirelessInventories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoriesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimCategories/{id}" : { "get" : { "description" : "Retrieve a claimCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimCategoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ClaimCategories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ClaimCategories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimCategoriesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimCategories" : { "get" : { "description" : "Retrieve a List of claimCategories resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_name]", "in" : "query", "description" : "Filter by claim_category_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_type]", "in" : "query", "description" : "Filter by claim_category_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claims]", "in" : "query", "description" : "Filter by claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimAllocationTypes]", "in" : "query", "description" : "Filter by claimAllocationTypes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategories]", "in" : "query", "description" : "Filter by claimSpendCategories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimCategoriesInclude" }, { "$ref" : "#/components/parameters/ClaimCategoriesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimCategoriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ClaimCategories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimCategoriesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimCategories/{id}/claims" : { "get" : { "description" : "Retrieve claims related to a claimCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimCategories/{id}/claimAllocationTypes" : { "get" : { "description" : "Retrieve claimAllocationTypes related to a claimCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_allocation_name]", "in" : "query", "description" : "Filter by type_allocation_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq]", "in" : "query", "description" : "Filter by seq (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimAllocationTypesFields" }, { "$ref" : "#/components/parameters/ClaimAllocationTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimCategories/{id}/claimSpendCategories" : { "get" : { "description" : "Retrieve claimSpendCategories related to a claimCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_damage_related]", "in" : "query", "description" : "Filter by facility_damage_related (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category]", "in" : "query", "description" : "Filter by spend_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_acct]", "in" : "query", "description" : "Filter by wd_acct (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[include_pl_rp_paid]", "in" : "query", "description" : "Filter by include_pl_rp_paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claims]", "in" : "query", "description" : "Filter by claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimCategories/{id}/relationships/claims" : { "get" : { "description" : "Retrieve claims references related to a claimCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimCategories/{id}/relationships/claimAllocationTypes" : { "get" : { "description" : "Retrieve claimAllocationTypes references related to a claimCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_allocation_name]", "in" : "query", "description" : "Filter by type_allocation_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seq]", "in" : "query", "description" : "Filter by seq (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimAllocationTypesFields" }, { "$ref" : "#/components/parameters/ClaimAllocationTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimAllocationTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimCategories/{id}/relationships/claimSpendCategories" : { "get" : { "description" : "Retrieve claimSpendCategories references related to a claimCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_damage_related]", "in" : "query", "description" : "Filter by facility_damage_related (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category]", "in" : "query", "description" : "Filter by spend_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_acct]", "in" : "query", "description" : "Filter by wd_acct (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[include_pl_rp_paid]", "in" : "query", "description" : "Filter by include_pl_rp_paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claims]", "in" : "query", "description" : "Filter by claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}" : { "get" : { "description" : "Retrieve a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Claims", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Claims", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims" : { "get" : { "description" : "Retrieve a List of claims resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" }, { "$ref" : "#/components/parameters/ClaimsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Claims", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/customer" : { "get" : { "description" : "Retrieve customers related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/claimCategory" : { "get" : { "description" : "Retrieve claimCategories related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimCategoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/damage" : { "get" : { "description" : "Retrieve damages related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/payeeAddress" : { "get" : { "description" : "Retrieve payeeAddresses related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/PayeeAddressesFields" }, { "$ref" : "#/components/parameters/PayeeAddressesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PayeeAddressesResourceResponse" }, "202" : { "$ref" : "#/components/responses/PayeeAddressesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/claimSpendCategory" : { "get" : { "description" : "Retrieve claimSpendCategories related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/claimDetails" : { "get" : { "description" : "Retrieve claimDetails related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_variance_reason_id]", "in" : "query", "description" : "Filter by estimate_variance_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_accrual_balance]", "in" : "query", "description" : "Filter by retain_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_version_number]", "in" : "query", "description" : "Filter by estimate_version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_balance]", "in" : "query", "description" : "Filter by estimate_accrued_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_amount]", "in" : "query", "description" : "Filter by estimate_accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/claimDiscounts" : { "get" : { "description" : "Retrieve claimDiscounts related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[discount_reason]", "in" : "query", "description" : "Filter by discount_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[discount_amount]", "in" : "query", "description" : "Filter by discount_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDiscountsFields" }, { "$ref" : "#/components/parameters/ClaimDiscountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDiscountsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDiscountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/relationships/customer" : { "get" : { "description" : "Retrieve customers references related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/relationships/claimCategory" : { "get" : { "description" : "Retrieve claimCategories references related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/relationships/damage" : { "get" : { "description" : "Retrieve damages references related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagesFields" }, { "$ref" : "#/components/parameters/DamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/relationships/payeeAddress" : { "get" : { "description" : "Retrieve payeeAddresses references related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/PayeeAddressesFields" }, { "$ref" : "#/components/parameters/PayeeAddressesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PayeeAddressesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/PayeeAddressesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/relationships/claimSpendCategory" : { "get" : { "description" : "Retrieve claimSpendCategories references related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/relationships/financialPeriod" : { "get" : { "description" : "Retrieve financialPeriods references related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/FinancialPeriodsFields" }, { "$ref" : "#/components/parameters/FinancialPeriodsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FinancialPeriodsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/relationships/claimDetails" : { "get" : { "description" : "Retrieve claimDetails references related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_variance_reason_id]", "in" : "query", "description" : "Filter by estimate_variance_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_accrual_balance]", "in" : "query", "description" : "Filter by retain_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_version_number]", "in" : "query", "description" : "Filter by estimate_version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_balance]", "in" : "query", "description" : "Filter by estimate_accrued_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_amount]", "in" : "query", "description" : "Filter by estimate_accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claims/{id}/relationships/claimDiscounts" : { "get" : { "description" : "Retrieve claimDiscounts references related to a claims resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[discount_reason]", "in" : "query", "description" : "Filter by discount_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[discount_amount]", "in" : "query", "description" : "Filter by discount_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDiscountsFields" }, { "$ref" : "#/components/parameters/ClaimDiscountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDiscountsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDiscountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionaireAnswersVersions/{id}" : { "get" : { "description" : "Retrieve a questionaireAnswersVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsFields" }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionaireAnswersVersionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuestionaireAnswersVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a QuestionaireAnswersVersions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/QuestionaireAnswersVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a QuestionaireAnswersVersions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuestionaireAnswersVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionaireAnswersVersions" : { "get" : { "description" : "Retrieve a List of questionaireAnswersVersions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[answer_id]", "in" : "query", "description" : "Filter by answer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[question_id]", "in" : "query", "description" : "Filter by question_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[answer]", "in" : "query", "description" : "Filter by answer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireAnswer]", "in" : "query", "description" : "Filter by questionnaireAnswer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireQuestion]", "in" : "query", "description" : "Filter by questionnaireQuestion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsFields" }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsInclude" }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionaireAnswersVersionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuestionaireAnswersVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a QuestionaireAnswersVersions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuestionaireAnswersVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionaireAnswersVersions/{id}/questionnaireAnswer" : { "get" : { "description" : "Retrieve questionnaireAnswers related to a questionaireAnswersVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersFields" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionaireAnswersVersions/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a questionaireAnswersVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionaireAnswersVersions/{id}/questionnaireQuestion" : { "get" : { "description" : "Retrieve questionnaireQuestions related to a questionaireAnswersVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsFields" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionaireAnswersVersions/{id}/relationships/questionnaireAnswer" : { "get" : { "description" : "Retrieve questionnaireAnswers references related to a questionaireAnswersVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersFields" }, { "$ref" : "#/components/parameters/QuestionnaireAnswersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireAnswersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionaireAnswersVersions/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a questionaireAnswersVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/questionaireAnswersVersions/{id}/relationships/questionnaireQuestion" : { "get" : { "description" : "Retrieve questionnaireQuestions references related to a questionaireAnswersVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuestionaireAnswersVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsFields" }, { "$ref" : "#/components/parameters/QuestionnaireQuestionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuestionnaireQuestionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodes/{id}" : { "get" : { "description" : "Retrieve a quickCode resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodePrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeFields" }, { "$ref" : "#/components/parameters/QuickCodeInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a QuickCode", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodePrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/QuickCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a QuickCode", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodePatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuickCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodes" : { "get" : { "description" : "Retrieve a List of quickCode resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValues]", "in" : "query", "description" : "Filter by quickCValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuickCodeFields" }, { "$ref" : "#/components/parameters/QuickCodeInclude" }, { "$ref" : "#/components/parameters/QuickCodeSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a QuickCode", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodePostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuickCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodes/{id}/quickCValues" : { "get" : { "description" : "Retrieve quickCodeValue related to a quickCode resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickC]", "in" : "query", "description" : "Filter by quickC (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigations]", "in" : "query", "description" : "Filter by investigations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodes/{id}/relationships/quickCValues" : { "get" : { "description" : "Retrieve quickCodeValue references related to a quickCode resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickC]", "in" : "query", "description" : "Filter by quickC (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigations]", "in" : "query", "description" : "Filter by investigations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms/{id}" : { "get" : { "description" : "Retrieve a terms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Terms", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Terms", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms" : { "get" : { "description" : "Retrieve a List of terms resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[code]", "in" : "query", "description" : "Filter by code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse]", "in" : "query", "description" : "Filter by parse (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[charge_once]", "in" : "query", "description" : "Filter by charge_once (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[respond_code]", "in" : "query", "description" : "Filter by respond_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[do_not_respond]", "in" : "query", "description" : "Filter by do_not_respond (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[read_from_master_code]", "in" : "query", "description" : "Filter by read_from_master_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[read_from_members]", "in" : "query", "description" : "Filter by read_from_members (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inactive]", "in" : "query", "description" : "Filter by inactive (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[create_audit_item]", "in" : "query", "description" : "Filter by create_audit_item (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[do_not_close]", "in" : "query", "description" : "Filter by do_not_close (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unlocatable_term_id]", "in" : "query", "description" : "Filter by unlocatable_term_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unlocatable_status_id]", "in" : "query", "description" : "Filter by unlocatable_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_text_only]", "in" : "query", "description" : "Filter by add_text_only (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshots]", "in" : "query", "description" : "Filter by locateClosedSnapshots (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshots]", "in" : "query", "description" : "Filter by locateOpenSnapshots (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" }, { "$ref" : "#/components/parameters/TermsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Terms", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms/{id}/feed" : { "get" : { "description" : "Retrieve feeds related to a terms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms/{id}/locates" : { "get" : { "description" : "Retrieve locates related to a terms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms/{id}/locateClosedSnapshots" : { "get" : { "description" : "Retrieve locateClosedSnapshots related to a terms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms/{id}/locateOpenSnapshots" : { "get" : { "description" : "Retrieve locateOpenSnapshots related to a terms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms/{id}/relationships/feed" : { "get" : { "description" : "Retrieve feeds references related to a terms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms/{id}/relationships/locates" : { "get" : { "description" : "Retrieve locates references related to a terms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms/{id}/relationships/locateClosedSnapshots" : { "get" : { "description" : "Retrieve locateClosedSnapshots references related to a terms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/terms/{id}/relationships/locateOpenSnapshots" : { "get" : { "description" : "Retrieve locateOpenSnapshots references related to a terms resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TermsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateOpenSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocateOpenSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/customers/{id}" : { "get" : { "description" : "Retrieve a tkpcustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpcustomersPrimaryKey" }, { "$ref" : "#/components/parameters/TkpcustomersFields" }, { "$ref" : "#/components/parameters/TkpcustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpcustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/TkpcustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Tkpcustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpcustomersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TkpcustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Tkpcustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpcustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpcustomersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpcustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/customers" : { "get" : { "description" : "Retrieve a List of tkpcustomers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_name]", "in" : "query", "description" : "Filter by account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccounts]", "in" : "query", "description" : "Filter by serviceAccounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccountLocateMatches]", "in" : "query", "description" : "Filter by serviceAccountLocateMatches (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TkpcustomersFields" }, { "$ref" : "#/components/parameters/TkpcustomersInclude" }, { "$ref" : "#/components/parameters/TkpcustomersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TkpcustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TkpcustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Tkpcustomers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpcustomersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpcustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TkpcustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/customers/{id}/serviceAccounts" : { "get" : { "description" : "Retrieve serviceAccounts related to a tkpcustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpcustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deleted]", "in" : "query", "description" : "Filter by deleted (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[modified_date]", "in" : "query", "description" : "Filter by modified_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expire_date]", "in" : "query", "description" : "Filter by expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_email]", "in" : "query", "description" : "Filter by contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_type]", "in" : "query", "description" : "Filter by billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccountRules]", "in" : "query", "description" : "Filter by serviceAccountRules (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccountLocateMatches]", "in" : "query", "description" : "Filter by serviceAccountLocateMatches (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsFields" }, { "$ref" : "#/components/parameters/ServiceAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/customers/{id}/serviceAccountLocateMatches" : { "get" : { "description" : "Retrieve serviceAccountLocateMatches related to a tkpcustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpcustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_customer_id]", "in" : "query", "description" : "Filter by service_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_expire_date]", "in" : "query", "description" : "Filter by service_expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_name]", "in" : "query", "description" : "Filter by service_contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_email]", "in" : "query", "description" : "Filter by service_contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_billing_type]", "in" : "query", "description" : "Filter by service_billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_feed_email]", "in" : "query", "description" : "Filter by service_feed_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_bore_footage]", "in" : "query", "description" : "Filter by service_bore_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpTicket]", "in" : "query", "description" : "Filter by tkpTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesFields" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/customers/{id}/relationships/serviceAccounts" : { "get" : { "description" : "Retrieve serviceAccounts references related to a tkpcustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpcustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deleted]", "in" : "query", "description" : "Filter by deleted (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[modified_date]", "in" : "query", "description" : "Filter by modified_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expire_date]", "in" : "query", "description" : "Filter by expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_email]", "in" : "query", "description" : "Filter by contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_type]", "in" : "query", "description" : "Filter by billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccountRules]", "in" : "query", "description" : "Filter by serviceAccountRules (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccountLocateMatches]", "in" : "query", "description" : "Filter by serviceAccountLocateMatches (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountsFields" }, { "$ref" : "#/components/parameters/ServiceAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/customers/{id}/relationships/serviceAccountLocateMatches" : { "get" : { "description" : "Retrieve serviceAccountLocateMatches references related to a tkpcustomers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TkpcustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_type]", "in" : "query", "description" : "Filter by service_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_id]", "in" : "query", "description" : "Filter by service_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_name]", "in" : "query", "description" : "Filter by service_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_customer_id]", "in" : "query", "description" : "Filter by service_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_expire_date]", "in" : "query", "description" : "Filter by service_expire_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_name]", "in" : "query", "description" : "Filter by service_contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_contact_email]", "in" : "query", "description" : "Filter by service_contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_billing_type]", "in" : "query", "description" : "Filter by service_billing_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_feed_email]", "in" : "query", "description" : "Filter by service_feed_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_bore_footage]", "in" : "query", "description" : "Filter by service_bore_footage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpServiceCustomer]", "in" : "query", "description" : "Filter by tkpServiceCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpTicket]", "in" : "query", "description" : "Filter by tkpTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesFields" }, { "$ref" : "#/components/parameters/ServiceAccountLocateMatchesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountLocateMatchesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributes/{id}" : { "get" : { "description" : "Retrieve a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAttributesFields" }, { "$ref" : "#/components/parameters/AssetAttributesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetAttributes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetAttributes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributes" : { "get" : { "description" : "Retrieve a List of assetAttributes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[label]", "in" : "query", "description" : "Filter by label (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_type]", "in" : "query", "description" : "Filter by data_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_field]", "in" : "query", "description" : "Filter by required_field (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributeMappings]", "in" : "query", "description" : "Filter by attributeMappings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAttributesFields" }, { "$ref" : "#/components/parameters/AssetAttributesInclude" }, { "$ref" : "#/components/parameters/AssetAttributesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetAttributes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributes/{id}/assetAttributeValues" : { "get" : { "description" : "Retrieve assetAttributeValues related to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[record_description]", "in" : "query", "description" : "Filter by record_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[update_process]", "in" : "query", "description" : "Filter by update_process (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesFields" }, { "$ref" : "#/components/parameters/AssetAttributeValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributes/{id}/attributeMappings" : { "get" : { "description" : "Retrieve attributeMappings related to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type_id]", "in" : "query", "description" : "Filter by asset_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributes/{id}/relationships/assetAttributeValues" : { "get" : { "description" : "Retrieve assetAttributeValues references related to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[record_description]", "in" : "query", "description" : "Filter by record_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[update_process]", "in" : "query", "description" : "Filter by update_process (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesFields" }, { "$ref" : "#/components/parameters/AssetAttributeValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributes/{id}/relationships/attributeMappings" : { "get" : { "description" : "Retrieve attributeMappings references related to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type_id]", "in" : "query", "description" : "Filter by asset_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventoryUsages/{id}" : { "get" : { "description" : "Retrieve a verizonWirelessInventoryUsages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a VerizonWirelessInventoryUsages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a VerizonWirelessInventoryUsages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventoryUsages" : { "get" : { "description" : "Retrieve a List of verizonWirelessInventoryUsages resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acct_no]", "in" : "query", "description" : "Filter by acct_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sub_acct_no]", "in" : "query", "description" : "Filter by sub_acct_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mdn]", "in" : "query", "description" : "Filter by mdn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_date]", "in" : "query", "description" : "Filter by usage_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_time]", "in" : "query", "description" : "Filter by usage_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_type]", "in" : "query", "description" : "Filter by usage_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_count]", "in" : "query", "description" : "Filter by usage_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[overseas_ind]", "in" : "query", "description" : "Filter by overseas_ind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[incoming_direction_ind]", "in" : "query", "description" : "Filter by incoming_direction_ind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dialed_digits]", "in" : "query", "description" : "Filter by dialed_digits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roaming_ind]", "in" : "query", "description" : "Filter by roaming_ind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[roaming_provider]", "in" : "query", "description" : "Filter by roaming_provider (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_code]", "in" : "query", "description" : "Filter by country_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[duration_time]", "in" : "query", "description" : "Filter by duration_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sequence_num]", "in" : "query", "description" : "Filter by sequence_num (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_type]", "in" : "query", "description" : "Filter by data_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filler]", "in" : "query", "description" : "Filter by filler (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[verizonWirelessInventoryUsageSummary]", "in" : "query", "description" : "Filter by verizonWirelessInventoryUsageSummary (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesInclude" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a VerizonWirelessInventoryUsages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventoryUsages/{id}/verizonWirelessInventoryUsageSummary" : { "get" : { "description" : "Retrieve verizonWirelessInventoryUsageSummaries related to a verizonWirelessInventoryUsages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create verizonWirelessInventoryUsages relationship to a verizonWirelessInventoryUsageSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete verizonWirelessInventoryUsages relationship to a verizonWirelessInventoryUsageSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update verizonWirelessInventoryUsages relationship to a verizonWirelessInventoryUsageSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/verizonWirelessInventoryUsages/{id}/relationships/verizonWirelessInventoryUsageSummary" : { "get" : { "description" : "Retrieve verizonWirelessInventoryUsageSummaries references related to a verizonWirelessInventoryUsages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesFields" }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsageSummariesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create verizonWirelessInventoryUsages relationship to a verizonWirelessInventoryUsageSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete verizonWirelessInventoryUsages relationship to a verizonWirelessInventoryUsageSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update verizonWirelessInventoryUsages relationship to a verizonWirelessInventoryUsageSummaries resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/VerizonWirelessInventoryUsagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimSpendCategories/{id}" : { "get" : { "description" : "Retrieve a claimSpendCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ClaimSpendCategories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ClaimSpendCategories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimSpendCategories" : { "get" : { "description" : "Retrieve a List of claimSpendCategories resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_damage_related]", "in" : "query", "description" : "Filter by facility_damage_related (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category]", "in" : "query", "description" : "Filter by spend_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_acct]", "in" : "query", "description" : "Filter by wd_acct (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[include_pl_rp_paid]", "in" : "query", "description" : "Filter by include_pl_rp_paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claims]", "in" : "query", "description" : "Filter by claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesInclude" }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ClaimSpendCategories", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ClaimSpendCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimSpendCategories/{id}/claimCategory" : { "get" : { "description" : "Retrieve claimCategories related to a claimSpendCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimCategoriesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimSpendCategories/{id}/claims" : { "get" : { "description" : "Retrieve claims related to a claimSpendCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimSpendCategories/{id}/relationships/claimCategory" : { "get" : { "description" : "Retrieve claimCategories references related to a claimSpendCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/ClaimCategoriesFields" }, { "$ref" : "#/components/parameters/ClaimCategoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ClaimCategoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/claimSpendCategories/{id}/relationships/claims" : { "get" : { "description" : "Retrieve claims references related to a claimSpendCategories resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ClaimSpendCategoriesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/customers/{id}" : { "get" : { "description" : "Retrieve a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Customers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Customers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/customers" : { "get" : { "description" : "Retrieve a List of customers resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_level_customer_id]", "in" : "query", "description" : "Filter by account_level_customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_level_customer]", "in" : "query", "description" : "Filter by account_level_customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contracts]", "in" : "query", "description" : "Filter by contracts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" }, { "$ref" : "#/components/parameters/CustomersSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Customers", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/customers/{id}/contracts" : { "get" : { "description" : "Retrieve contracts related to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_number]", "in" : "query", "description" : "Filter by customer_contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_contract_number]", "in" : "query", "description" : "Filter by usic_contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_name]", "in" : "query", "description" : "Filter by account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_effective_date]", "in" : "query", "description" : "Filter by contract_effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_expiration_date]", "in" : "query", "description" : "Filter by contract_expiration_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_stage]", "in" : "query", "description" : "Filter by contract_stage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_type]", "in" : "query", "description" : "Filter by contract_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_utility_type]", "in" : "query", "description" : "Filter by primary_utility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type]", "in" : "query", "description" : "Filter by utility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quote]", "in" : "query", "description" : "Filter by quote (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_contract_type]", "in" : "query", "description" : "Filter by usic_contract_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_liability]", "in" : "query", "description" : "Filter by damage_liability (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_contract_number]", "in" : "query", "description" : "Filter by master_contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ContractsFields" }, { "$ref" : "#/components/parameters/ContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customers relationship to a contracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customers relationship to a contracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customers relationship to a contracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/customers/{id}/relationships/contracts" : { "get" : { "description" : "Retrieve contracts references related to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_number]", "in" : "query", "description" : "Filter by customer_contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_contract_number]", "in" : "query", "description" : "Filter by usic_contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_name]", "in" : "query", "description" : "Filter by account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_effective_date]", "in" : "query", "description" : "Filter by contract_effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_expiration_date]", "in" : "query", "description" : "Filter by contract_expiration_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_stage]", "in" : "query", "description" : "Filter by contract_stage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_type]", "in" : "query", "description" : "Filter by contract_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_utility_type]", "in" : "query", "description" : "Filter by primary_utility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type]", "in" : "query", "description" : "Filter by utility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quote]", "in" : "query", "description" : "Filter by quote (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_contract_type]", "in" : "query", "description" : "Filter by usic_contract_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_liability]", "in" : "query", "description" : "Filter by damage_liability (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_contract_number]", "in" : "query", "description" : "Filter by master_contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ContractsFields" }, { "$ref" : "#/components/parameters/ContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customers relationship to a contracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customers relationship to a contracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customers relationship to a contracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomersPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountRules/{id}" : { "get" : { "description" : "Retrieve a serviceAccountRules resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountRulesPrimaryKey" }, { "$ref" : "#/components/parameters/ServiceAccountRulesFields" }, { "$ref" : "#/components/parameters/ServiceAccountRulesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountRulesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountRulesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ServiceAccountRules", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountRulesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ServiceAccountRulesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ServiceAccountRules", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountRulesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountRulesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ServiceAccountRulesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountRules" : { "get" : { "description" : "Retrieve a List of serviceAccountRules resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_account_id]", "in" : "query", "description" : "Filter by service_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_include]", "in" : "query", "description" : "Filter by excavator_include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_exclude]", "in" : "query", "description" : "Filter by excavator_exclude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for_include]", "in" : "query", "description" : "Filter by work_done_for_include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for_exclude]", "in" : "query", "description" : "Filter by work_done_for_exclude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[external]", "in" : "query", "description" : "Filter by external (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deleted]", "in" : "query", "description" : "Filter by deleted (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_date]", "in" : "query", "description" : "Filter by created_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[modified_date]", "in" : "query", "description" : "Filter by modified_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by_user_id]", "in" : "query", "description" : "Filter by created_by_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_type]", "in" : "query", "description" : "Filter by work_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serviceAccount]", "in" : "query", "description" : "Filter by serviceAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ServiceAccountRulesFields" }, { "$ref" : "#/components/parameters/ServiceAccountRulesInclude" }, { "$ref" : "#/components/parameters/ServiceAccountRulesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountRulesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountRulesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ServiceAccountRules", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountRulesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ServiceAccountRulesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountRules/{id}/serviceAccount" : { "get" : { "description" : "Retrieve serviceAccounts related to a serviceAccountRules resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountRulesPrimaryKey" }, { "$ref" : "#/components/parameters/ServiceAccountsFields" }, { "$ref" : "#/components/parameters/ServiceAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketproServices/1.0/serviceAccountRules/{id}/relationships/serviceAccount" : { "get" : { "description" : "Retrieve serviceAccounts references related to a serviceAccountRules resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ServiceAccountRulesPrimaryKey" }, { "$ref" : "#/components/parameters/ServiceAccountsFields" }, { "$ref" : "#/components/parameters/ServiceAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ServiceAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributeValues/{id}" : { "get" : { "description" : "Retrieve a assetAttributeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAttributeValuesFields" }, { "$ref" : "#/components/parameters/AssetAttributeValuesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetAttributeValues", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetAttributeValues", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributeValues" : { "get" : { "description" : "Retrieve a List of assetAttributeValues resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[record_description]", "in" : "query", "description" : "Filter by record_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[update_process]", "in" : "query", "description" : "Filter by update_process (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesFields" }, { "$ref" : "#/components/parameters/AssetAttributeValuesInclude" }, { "$ref" : "#/components/parameters/AssetAttributeValuesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributeValuesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetAttributeValues", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetAttributeValuesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributeValues/{id}/assetAttribute" : { "get" : { "description" : "Retrieve assetAttributes related to a assetAttributeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAttributesFields" }, { "$ref" : "#/components/parameters/AssetAttributesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAttributeValues relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAttributeValues relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAttributeValues relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetAttributeValues/{id}/relationships/assetAttribute" : { "get" : { "description" : "Retrieve assetAttributes references related to a assetAttributeValues resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetAttributesFields" }, { "$ref" : "#/components/parameters/AssetAttributesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create assetAttributeValues relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete assetAttributeValues relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update assetAttributeValues relationship to a assetAttributes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetAttributeValuesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAttributesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetAttributesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/excavator/{id}" : { "get" : { "description" : "Retrieve a excavator resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ExcavatorPrimaryKey" }, { "$ref" : "#/components/parameters/ExcavatorFields" }, { "$ref" : "#/components/parameters/ExcavatorInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ExcavatorResourceResponse" }, "202" : { "$ref" : "#/components/responses/ExcavatorResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Excavator", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ExcavatorPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ExcavatorResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Excavator", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ExcavatorPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ExcavatorPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ExcavatorResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/excavator" : { "get" : { "description" : "Retrieve a List of excavator resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_phone_number]", "in" : "query", "description" : "Filter by contact_phone_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_email]", "in" : "query", "description" : "Filter by contact_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigations]", "in" : "query", "description" : "Filter by investigations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ExcavatorFields" }, { "$ref" : "#/components/parameters/ExcavatorInclude" }, { "$ref" : "#/components/parameters/ExcavatorSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ExcavatorResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ExcavatorResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Excavator", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ExcavatorPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ExcavatorResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ExcavatorResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/excavator/{id}/investigations" : { "get" : { "description" : "Retrieve investigations related to a excavator resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ExcavatorPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavationType]", "in" : "query", "description" : "Filter by excavationType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavat]", "in" : "query", "description" : "Filter by excavat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetails]", "in" : "query", "description" : "Filter by investigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersions]", "in" : "query", "description" : "Filter by investigationVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetails]", "in" : "query", "description" : "Filter by cmsInvestigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenEmployee]", "in" : "query", "description" : "Filter by picsTakenEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireAnswers]", "in" : "query", "description" : "Filter by questionnaireAnswers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/excavator/{id}/relationships/investigations" : { "get" : { "description" : "Retrieve investigations references related to a excavator resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ExcavatorPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavationType]", "in" : "query", "description" : "Filter by excavationType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavat]", "in" : "query", "description" : "Filter by excavat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetails]", "in" : "query", "description" : "Filter by investigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersions]", "in" : "query", "description" : "Filter by investigationVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetails]", "in" : "query", "description" : "Filter by cmsInvestigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenEmployee]", "in" : "query", "description" : "Filter by picsTakenEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireAnswers]", "in" : "query", "description" : "Filter by questionnaireAnswers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attWirelessInventoryUsages/{id}" : { "get" : { "description" : "Retrieve a attWirelessInventoryUsages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttWirelessInventoryUsagesPrimaryKey" }, { "$ref" : "#/components/parameters/AttWirelessInventoryUsagesFields" }, { "$ref" : "#/components/parameters/AttWirelessInventoryUsagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttWirelessInventoryUsagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AttWirelessInventoryUsages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttWirelessInventoryUsagesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AttWirelessInventoryUsages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttWirelessInventoryUsagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/attWirelessInventoryUsages" : { "get" : { "description" : "Retrieve a List of attWirelessInventoryUsages resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ban]", "in" : "query", "description" : "Filter by ban (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fan]", "in" : "query", "description" : "Filter by fan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_requested_date]", "in" : "query", "description" : "Filter by usage_requested_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_cycle_end_date]", "in" : "query", "description" : "Filter by billing_cycle_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voice_plan_name]", "in" : "query", "description" : "Filter by voice_plan_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voice_minutes_anytime]", "in" : "query", "description" : "Filter by voice_minutes_anytime (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_plan_name_1]", "in" : "query", "description" : "Filter by data_plan_name_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_usage_1]", "in" : "query", "description" : "Filter by data_usage_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_plan_name_2]", "in" : "query", "description" : "Filter by data_plan_name_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_usage_2]", "in" : "query", "description" : "Filter by data_usage_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_plan_name_3]", "in" : "query", "description" : "Filter by data_plan_name_3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_usage_3]", "in" : "query", "description" : "Filter by data_usage_3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_plan_name_4]", "in" : "query", "description" : "Filter by data_plan_name_4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_usage_4]", "in" : "query", "description" : "Filter by data_usage_4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttWirelessInventoryUsagesFields" }, { "$ref" : "#/components/parameters/AttWirelessInventoryUsagesInclude" }, { "$ref" : "#/components/parameters/AttWirelessInventoryUsagesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttWirelessInventoryUsagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AttWirelessInventoryUsages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttWirelessInventoryUsagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/cpDistricts/{id}" : { "get" : { "description" : "Retrieve a cpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/CpDistrictsFields" }, { "$ref" : "#/components/parameters/CpDistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CpDistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CpDistricts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CpDistricts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpDistrictsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/cpDistricts" : { "get" : { "description" : "Retrieve a List of cpDistricts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_workday_id]", "in" : "query", "description" : "Filter by cp_workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_district_code]", "in" : "query", "description" : "Filter by cp_district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_district_abbr]", "in" : "query", "description" : "Filter by cp_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_district_name]", "in" : "query", "description" : "Filter by cp_district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_state]", "in" : "query", "description" : "Filter by cp_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_region]", "in" : "query", "description" : "Filter by cp_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_created_on]", "in" : "query", "description" : "Filter by cp_created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_created_by]", "in" : "query", "description" : "Filter by cp_created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_last_updated_on]", "in" : "query", "description" : "Filter by cp_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_last_updated_by]", "in" : "query", "description" : "Filter by cp_last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usicContacts]", "in" : "query", "description" : "Filter by usicContacts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CpDistrictsFields" }, { "$ref" : "#/components/parameters/CpDistrictsInclude" }, { "$ref" : "#/components/parameters/CpDistrictsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CpDistrictsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CpDistricts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpDistrictsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpDistrictsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CpDistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/cpDistricts/{id}/usicContacts" : { "get" : { "description" : "Retrieve usicContacts related to a cpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_state]", "in" : "query", "description" : "Filter by district_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line1]", "in" : "query", "description" : "Filter by address_line1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line2]", "in" : "query", "description" : "Filter by address_line2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line3]", "in" : "query", "description" : "Filter by address_line3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_name]", "in" : "query", "description" : "Filter by dm_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_email]", "in" : "query", "description" : "Filter by dm_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_phone_no]", "in" : "query", "description" : "Filter by dm_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr]", "in" : "query", "description" : "Filter by hr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr_phone_no]", "in" : "query", "description" : "Filter by hr_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_name]", "in" : "query", "description" : "Filter by rd_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_phone_no]", "in" : "query", "description" : "Filter by rd_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_email]", "in" : "query", "description" : "Filter by rd_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[it_support]", "in" : "query", "description" : "Filter by it_support (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[it_support_phone_no]", "in" : "query", "description" : "Filter by it_support_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_contact]", "in" : "query", "description" : "Filter by sales_contact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_phone_no]", "in" : "query", "description" : "Filter by sales_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_email]", "in" : "query", "description" : "Filter by sales_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_contact]", "in" : "query", "description" : "Filter by general_contact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_phone_no]", "in" : "query", "description" : "Filter by general_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_email]", "in" : "query", "description" : "Filter by general_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpDistrict]", "in" : "query", "description" : "Filter by cpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UsicContactsFields" }, { "$ref" : "#/components/parameters/UsicContactsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create cpDistricts relationship to a usicContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete cpDistricts relationship to a usicContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update cpDistricts relationship to a usicContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/cpDistricts/{id}/relationships/usicContacts" : { "get" : { "description" : "Retrieve usicContacts references related to a cpDistricts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_state]", "in" : "query", "description" : "Filter by district_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line1]", "in" : "query", "description" : "Filter by address_line1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line2]", "in" : "query", "description" : "Filter by address_line2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address_line3]", "in" : "query", "description" : "Filter by address_line3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_name]", "in" : "query", "description" : "Filter by dm_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_email]", "in" : "query", "description" : "Filter by dm_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dm_phone_no]", "in" : "query", "description" : "Filter by dm_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr]", "in" : "query", "description" : "Filter by hr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hr_phone_no]", "in" : "query", "description" : "Filter by hr_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_name]", "in" : "query", "description" : "Filter by rd_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_phone_no]", "in" : "query", "description" : "Filter by rd_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rd_email]", "in" : "query", "description" : "Filter by rd_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[it_support]", "in" : "query", "description" : "Filter by it_support (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[it_support_phone_no]", "in" : "query", "description" : "Filter by it_support_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_contact]", "in" : "query", "description" : "Filter by sales_contact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_phone_no]", "in" : "query", "description" : "Filter by sales_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sales_email]", "in" : "query", "description" : "Filter by sales_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_contact]", "in" : "query", "description" : "Filter by general_contact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_phone_no]", "in" : "query", "description" : "Filter by general_phone_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[general_email]", "in" : "query", "description" : "Filter by general_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpDistrict]", "in" : "query", "description" : "Filter by cpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UsicContactsFields" }, { "$ref" : "#/components/parameters/UsicContactsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create cpDistricts relationship to a usicContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete cpDistricts relationship to a usicContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update cpDistricts relationship to a usicContacts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CpDistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UsicContactsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts/{id}" : { "get" : { "description" : "Retrieve a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CustomerAccounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CustomerAccounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts" : { "get" : { "description" : "Retrieve a List of customerAccounts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parent_account_number]", "in" : "query", "description" : "Filter by parent_account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_name]", "in" : "query", "description" : "Filter by account_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[alt_name]", "in" : "query", "description" : "Filter by alt_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_status]", "in" : "query", "description" : "Filter by item_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContracts]", "in" : "query", "description" : "Filter by customerContracts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccountNotes]", "in" : "query", "description" : "Filter by customerAccountNotes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContractSettings]", "in" : "query", "description" : "Filter by customerContractSettings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccountContractAccess]", "in" : "query", "description" : "Filter by userAccountContractAccess (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsFields" }, { "$ref" : "#/components/parameters/CustomerAccountsInclude" }, { "$ref" : "#/components/parameters/CustomerAccountsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CustomerAccounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerAccountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts/{id}/customerContracts" : { "get" : { "description" : "Retrieve customerContracts related to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_status]", "in" : "query", "description" : "Filter by item_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccountContractAccesses]", "in" : "query", "description" : "Filter by userAccountContractAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContractSetting]", "in" : "query", "description" : "Filter by customerContractSetting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerAccounts relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerAccounts relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerAccounts relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts/{id}/customerAccountNotes" : { "get" : { "description" : "Retrieve customerAccountNotes related to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[note]", "in" : "query", "description" : "Filter by note (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesFields" }, { "$ref" : "#/components/parameters/CustomerAccountNotesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerAccounts relationship to a customerAccountNotes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerAccounts relationship to a customerAccountNotes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerAccounts relationship to a customerAccountNotes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts/{id}/userAccesses" : { "get" : { "description" : "Retrieve userAccesses related to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_states]", "in" : "query", "description" : "Filter by customer_states (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccessesFields" }, { "$ref" : "#/components/parameters/UserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts/{id}/customerContractSettings" : { "get" : { "description" : "Retrieve customerContractSettings related to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[theme]", "in" : "query", "description" : "Filter by theme (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filter_attachments]", "in" : "query", "description" : "Filter by filter_attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsFields" }, { "$ref" : "#/components/parameters/CustomerContractSettingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts/{id}/relationships/customerContracts" : { "get" : { "description" : "Retrieve customerContracts references related to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_name]", "in" : "query", "description" : "Filter by contract_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[item_status]", "in" : "query", "description" : "Filter by item_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccountContractAccesses]", "in" : "query", "description" : "Filter by userAccountContractAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userAccesses]", "in" : "query", "description" : "Filter by userAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContractSetting]", "in" : "query", "description" : "Filter by customerContractSetting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerContractsFields" }, { "$ref" : "#/components/parameters/CustomerContractsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerAccounts relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerAccounts relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerAccounts relationship to a customerContracts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts/{id}/relationships/customerAccountNotes" : { "get" : { "description" : "Retrieve customerAccountNotes references related to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[note]", "in" : "query", "description" : "Filter by note (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerAccountNotesFields" }, { "$ref" : "#/components/parameters/CustomerAccountNotesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerAccounts relationship to a customerAccountNotes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerAccounts relationship to a customerAccountNotes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerAccounts relationship to a customerAccountNotes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerAccountNotesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts/{id}/relationships/userAccesses" : { "get" : { "description" : "Retrieve userAccesses references related to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_account_id]", "in" : "query", "description" : "Filter by customer_account_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_contract_id]", "in" : "query", "description" : "Filter by customer_contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_states]", "in" : "query", "description" : "Filter by customer_states (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user]", "in" : "query", "description" : "Filter by user (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserAccessesFields" }, { "$ref" : "#/components/parameters/UserAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerAccounts/{id}/relationships/customerContractSettings" : { "get" : { "description" : "Retrieve customerContractSettings references related to a customerAccounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerAccountsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[theme]", "in" : "query", "description" : "Filter by theme (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filter_attachments]", "in" : "query", "description" : "Filter by filter_attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerContract]", "in" : "query", "description" : "Filter by customerContract (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customerAccount]", "in" : "query", "description" : "Filter by customerAccount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerContractSettingsFields" }, { "$ref" : "#/components/parameters/CustomerContractSettingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractSettingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionExtras/{id}" : { "get" : { "description" : "Retrieve a transmissionExtras resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionExtrasPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TransmissionExtras", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionExtrasPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TransmissionExtras", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionExtrasPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionExtrasPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionExtras" : { "get" : { "description" : "Retrieve a List of transmissionExtras resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[marking_instructions]", "in" : "query", "description" : "Filter by marking_instructions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_ref]", "in" : "query", "description" : "Filter by cross_ref (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[township]", "in" : "query", "description" : "Filter by township (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_ticket_number]", "in" : "query", "description" : "Filter by original_ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_ticket_id]", "in" : "query", "description" : "Filter by original_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact]", "in" : "query", "description" : "Filter by contact (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[identifier]", "in" : "query", "description" : "Filter by identifier (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[depth]", "in" : "query", "description" : "Filter by depth (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_seq]", "in" : "query", "description" : "Filter by contract_seq (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_means]", "in" : "query", "description" : "Filter by excavation_means (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_state]", "in" : "query", "description" : "Filter by excavator_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_zip]", "in" : "query", "description" : "Filter by excavator_zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sidewalk]", "in" : "query", "description" : "Filter by sidewalk (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_street]", "in" : "query", "description" : "Filter by in_street (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remark]", "in" : "query", "description" : "Filter by remark (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[driving_instructions]", "in" : "query", "description" : "Filter by driving_instructions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[duration]", "in" : "query", "description" : "Filter by duration (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[single_address]", "in" : "query", "description" : "Filter by single_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_mobile]", "in" : "query", "description" : "Filter by contact_mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[whitelined]", "in" : "query", "description" : "Filter by whitelined (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" }, { "$ref" : "#/components/parameters/TransmissionExtrasSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TransmissionExtras", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionExtrasPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionExtras/{id}/locates" : { "get" : { "description" : "Retrieve locates related to a transmissionExtras resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionExtrasPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionExtras/{id}/relationships/locates" : { "get" : { "description" : "Retrieve locates references related to a transmissionExtras resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionExtrasPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}" : { "get" : { "description" : "Retrieve a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a InvestigationDetailsVersions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a InvestigationDetailsVersions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions" : { "get" : { "description" : "Retrieve a List of investigationDetailsVersions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_date]", "in" : "query", "description" : "Filter by changed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changed_by]", "in" : "query", "description" : "Filter by changed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_version_id]", "in" : "query", "description" : "Filter by investigation_version_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersion]", "in" : "query", "description" : "Filter by investigationVersion (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completedBy]", "in" : "query", "description" : "Filter by completedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[changedBy]", "in" : "query", "description" : "Filter by changedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsCustomer]", "in" : "query", "description" : "Filter by cmsCustomer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsInclude" }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a InvestigationDetailsVersions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/investigationVersion" : { "get" : { "description" : "Retrieve investigationVersions related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationVersionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/investigationDetail" : { "get" : { "description" : "Retrieve investigationDetails related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/locator" : { "get" : { "description" : "Retrieve employees related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/completedBy" : { "get" : { "description" : "Retrieve employees related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/changedBy" : { "get" : { "description" : "Retrieve employees related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/relationships/investigationVersion" : { "get" : { "description" : "Retrieve investigationVersions references related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationVersionsFields" }, { "$ref" : "#/components/parameters/InvestigationVersionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationVersionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/relationships/investigationDetail" : { "get" : { "description" : "Retrieve investigationDetails references related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationDetailsFields" }, { "$ref" : "#/components/parameters/InvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/relationships/locator" : { "get" : { "description" : "Retrieve employees references related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/relationships/completedBy" : { "get" : { "description" : "Retrieve employees references related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/relationships/changedBy" : { "get" : { "description" : "Retrieve employees references related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/investigationDetailsVersions/{id}/relationships/cmsCustomer" : { "get" : { "description" : "Retrieve cmsCustomers references related to a investigationDetailsVersions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailsVersionsPrimaryKey" }, { "$ref" : "#/components/parameters/CmsCustomersFields" }, { "$ref" : "#/components/parameters/CmsCustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsCustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CmsCustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}" : { "get" : { "description" : "Retrieve a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Employees", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Employees", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees" : { "get" : { "description" : "Retrieve a List of employees resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action]", "in" : "query", "description" : "Filter by action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimated_return_date]", "in" : "query", "description" : "Filter by estimated_return_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[announcements]", "in" : "query", "description" : "Filter by announcements (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignments]", "in" : "query", "description" : "Filter by assignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[requests]", "in" : "query", "description" : "Filter by requests (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acceptedAssets]", "in" : "query", "description" : "Filter by acceptedAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userDataAccesses]", "in" : "query", "description" : "Filter by userDataAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deviceTokens]", "in" : "query", "description" : "Filter by deviceTokens (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeMessages]", "in" : "query", "description" : "Filter by employeeMessages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messages]", "in" : "query", "description" : "Filter by messages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobsInfo]", "in" : "query", "description" : "Filter by schedulerJobsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigations]", "in" : "query", "description" : "Filter by investigations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[comments]", "in" : "query", "description" : "Filter by comments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ideas]", "in" : "query", "description" : "Filter by ideas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" }, { "$ref" : "#/components/parameters/EmployeesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Employees", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/dist" : { "get" : { "description" : "Retrieve districts related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/announcements" : { "get" : { "description" : "Retrieve announcements related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[announcement_text]", "in" : "query", "description" : "Filter by announcement_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_priority]", "in" : "query", "description" : "Filter by high_priority (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AnnouncementsFields" }, { "$ref" : "#/components/parameters/AnnouncementsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a announcements resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a announcements resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a announcements resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/assetAssignments" : { "get" : { "description" : "Retrieve assetAssignments related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/assignments" : { "get" : { "description" : "Retrieve assetAssignments related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/requests" : { "get" : { "description" : "Retrieve requests related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userid]", "in" : "query", "description" : "Filter by userid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[username]", "in" : "query", "description" : "Filter by username (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[session_id]", "in" : "query", "description" : "Filter by session_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_time]", "in" : "query", "description" : "Filter by start_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_time]", "in" : "query", "description" : "Filter by end_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_name]", "in" : "query", "description" : "Filter by request_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_type]", "in" : "query", "description" : "Filter by request_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_status]", "in" : "query", "description" : "Filter by completed_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param1]", "in" : "query", "description" : "Filter by param1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param2]", "in" : "query", "description" : "Filter by param2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param3]", "in" : "query", "description" : "Filter by param3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param4]", "in" : "query", "description" : "Filter by param4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param5]", "in" : "query", "description" : "Filter by param5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param6]", "in" : "query", "description" : "Filter by param6 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param7]", "in" : "query", "description" : "Filter by param7 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param8]", "in" : "query", "description" : "Filter by param8 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param9]", "in" : "query", "description" : "Filter by param9 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param10]", "in" : "query", "description" : "Filter by param10 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RequestsFields" }, { "$ref" : "#/components/parameters/RequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a requests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a requests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a requests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/acceptedAssets" : { "get" : { "description" : "Retrieve assets related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/wirelessInventories" : { "get" : { "description" : "Retrieve wirelessInventories related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_number]", "in" : "query", "description" : "Filter by wireless_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_vendor]", "in" : "query", "description" : "Filter by wireless_vendor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_full_name]", "in" : "query", "description" : "Filter by wireless_user_full_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_status]", "in" : "query", "description" : "Filter by wireless_user_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[truck_vin]", "in" : "query", "description" : "Filter by truck_vin (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imei]", "in" : "query", "description" : "Filter by imei (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sim_number]", "in" : "query", "description" : "Filter by sim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_model]", "in" : "query", "description" : "Filter by device_model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_end_date]", "in" : "query", "description" : "Filter by contract_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_usage]", "in" : "query", "description" : "Filter by data_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voice_usage]", "in" : "query", "description" : "Filter by voice_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[text_usage]", "in" : "query", "description" : "Filter by text_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[total_charges]", "in" : "query", "description" : "Filter by total_charges (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_last_updated_on]", "in" : "query", "description" : "Filter by device_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_last_updated_on]", "in" : "query", "description" : "Filter by usage_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesFields" }, { "$ref" : "#/components/parameters/WirelessInventoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WirelessInventoriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/vehicles" : { "get" : { "description" : "Retrieve vehicles related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cvn]", "in" : "query", "description" : "Filter by cvn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_year]", "in" : "query", "description" : "Filter by model_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make]", "in" : "query", "description" : "Filter by make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_group]", "in" : "query", "description" : "Filter by model_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vin_number]", "in" : "query", "description" : "Filter by vin_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[license_plate_number]", "in" : "query", "description" : "Filter by license_plate_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/userDataAccesses" : { "get" : { "description" : "Retrieve userDataAccesses related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_districts]", "in" : "query", "description" : "Filter by all_districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_supgroups]", "in" : "query", "description" : "Filter by all_supgroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesFields" }, { "$ref" : "#/components/parameters/UserDataAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/locatorCheckins" : { "get" : { "description" : "Retrieve locatorCheckins related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[checkin_action]", "in" : "query", "description" : "Filter by checkin_action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_version]", "in" : "query", "description" : "Filter by asset_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_on]", "in" : "query", "description" : "Filter by reviewed_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsFields" }, { "$ref" : "#/components/parameters/LocatorCheckinsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/deviceTokens" : { "get" : { "description" : "Retrieve deviceTokens related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_token]", "in" : "query", "description" : "Filter by device_token (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DeviceTokensFields" }, { "$ref" : "#/components/parameters/DeviceTokensInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a deviceTokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a deviceTokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a deviceTokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/employeeMessages" : { "get" : { "description" : "Retrieve employeeMessages related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sent_at]", "in" : "query", "description" : "Filter by sent_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_read_at]", "in" : "query", "description" : "Filter by first_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_read_at]", "in" : "query", "description" : "Filter by last_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cleared_at]", "in" : "query", "description" : "Filter by cleared_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledged_at]", "in" : "query", "description" : "Filter by acknowledged_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[channel]", "in" : "query", "description" : "Filter by channel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recipient_email]", "in" : "query", "description" : "Filter by recipient_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_detail]", "in" : "query", "description" : "Filter by delivery_detail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_attempts]", "in" : "query", "description" : "Filter by delivery_attempts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimed_at]", "in" : "query", "description" : "Filter by claimed_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerInfo]", "in" : "query", "description" : "Filter by schedulerInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messageWithCount]", "in" : "query", "description" : "Filter by messageWithCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesFields" }, { "$ref" : "#/components/parameters/EmployeeMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/messages" : { "get" : { "description" : "Retrieve messages related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subject]", "in" : "query", "description" : "Filter by subject (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_preview]", "in" : "query", "description" : "Filter by message_preview (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_acknowledgement]", "in" : "query", "description" : "Filter by require_acknowledgement (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unreadCount]", "in" : "query", "description" : "Filter by unreadCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[readCount]", "in" : "query", "description" : "Filter by readCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sentCount]", "in" : "query", "description" : "Filter by sentCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledgedCount]", "in" : "query", "description" : "Filter by acknowledgedCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeMessages]", "in" : "query", "description" : "Filter by employeeMessages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/MessagesFields" }, { "$ref" : "#/components/parameters/MessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/schedulerJobsInfo" : { "get" : { "description" : "Retrieve schedulerJobs related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_group]", "in" : "query", "description" : "Filter by job_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_class]", "in" : "query", "description" : "Filter by job_class (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_expression]", "in" : "query", "description" : "Filter by cron_expression (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repeat_time]", "in" : "query", "description" : "Filter by repeat_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_job]", "in" : "query", "description" : "Filter by cron_job (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[time_zone]", "in" : "query", "description" : "Filter by time_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parameters]", "in" : "query", "description" : "Filter by parameters (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[jobInfo]", "in" : "query", "description" : "Filter by jobInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobStatus]", "in" : "query", "description" : "Filter by schedulerJobStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsFields" }, { "$ref" : "#/components/parameters/SchedulerJobsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/investigations" : { "get" : { "description" : "Retrieve investigations related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavationType]", "in" : "query", "description" : "Filter by excavationType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavat]", "in" : "query", "description" : "Filter by excavat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetails]", "in" : "query", "description" : "Filter by investigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersions]", "in" : "query", "description" : "Filter by investigationVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetails]", "in" : "query", "description" : "Filter by cmsInvestigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenEmployee]", "in" : "query", "description" : "Filter by picsTakenEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireAnswers]", "in" : "query", "description" : "Filter by questionnaireAnswers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/comments" : { "get" : { "description" : "Retrieve comments related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[content]", "in" : "query", "description" : "Filter by content (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea_id]", "in" : "query", "description" : "Filter by idea_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[author_id]", "in" : "query", "description" : "Filter by author_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea]", "in" : "query", "description" : "Filter by idea (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CommentsFields" }, { "$ref" : "#/components/parameters/CommentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CommentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/ideas" : { "get" : { "description" : "Retrieve ideas related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[content]", "in" : "query", "description" : "Filter by content (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[kind_id]", "in" : "query", "description" : "Filter by kind_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[author_id]", "in" : "query", "description" : "Filter by author_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_or_rejected_on]", "in" : "query", "description" : "Filter by approved_or_rejected_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_or_rejected_by]", "in" : "query", "description" : "Filter by approved_or_rejected_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[kind]", "in" : "query", "description" : "Filter by kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[comments]", "in" : "query", "description" : "Filter by comments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[votes]", "in" : "query", "description" : "Filter by votes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/IdeasFields" }, { "$ref" : "#/components/parameters/IdeasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeasResourcesResponse" }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/dist" : { "get" : { "description" : "Retrieve districts references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/announcements" : { "get" : { "description" : "Retrieve announcements references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[announcement_text]", "in" : "query", "description" : "Filter by announcement_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_priority]", "in" : "query", "description" : "Filter by high_priority (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AnnouncementsFields" }, { "$ref" : "#/components/parameters/AnnouncementsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a announcements resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a announcements resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a announcements resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AnnouncementsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/assetAssignments" : { "get" : { "description" : "Retrieve assetAssignments references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/assignments" : { "get" : { "description" : "Retrieve assetAssignments references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a assetAssignments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/requests" : { "get" : { "description" : "Retrieve requests references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userid]", "in" : "query", "description" : "Filter by userid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[username]", "in" : "query", "description" : "Filter by username (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[session_id]", "in" : "query", "description" : "Filter by session_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_time]", "in" : "query", "description" : "Filter by start_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_time]", "in" : "query", "description" : "Filter by end_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_name]", "in" : "query", "description" : "Filter by request_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_type]", "in" : "query", "description" : "Filter by request_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_status]", "in" : "query", "description" : "Filter by completed_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param1]", "in" : "query", "description" : "Filter by param1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param2]", "in" : "query", "description" : "Filter by param2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param3]", "in" : "query", "description" : "Filter by param3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param4]", "in" : "query", "description" : "Filter by param4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param5]", "in" : "query", "description" : "Filter by param5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param6]", "in" : "query", "description" : "Filter by param6 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param7]", "in" : "query", "description" : "Filter by param7 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param8]", "in" : "query", "description" : "Filter by param8 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param9]", "in" : "query", "description" : "Filter by param9 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[param10]", "in" : "query", "description" : "Filter by param10 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/RequestsFields" }, { "$ref" : "#/components/parameters/RequestsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a requests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a requests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a requests resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/RequestsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/acceptedAssets" : { "get" : { "description" : "Retrieve assets references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/wirelessInventories" : { "get" : { "description" : "Retrieve wirelessInventories references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_number]", "in" : "query", "description" : "Filter by wireless_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_vendor]", "in" : "query", "description" : "Filter by wireless_vendor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_full_name]", "in" : "query", "description" : "Filter by wireless_user_full_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_status]", "in" : "query", "description" : "Filter by wireless_user_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[truck_vin]", "in" : "query", "description" : "Filter by truck_vin (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imei]", "in" : "query", "description" : "Filter by imei (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sim_number]", "in" : "query", "description" : "Filter by sim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_model]", "in" : "query", "description" : "Filter by device_model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_end_date]", "in" : "query", "description" : "Filter by contract_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_usage]", "in" : "query", "description" : "Filter by data_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voice_usage]", "in" : "query", "description" : "Filter by voice_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[text_usage]", "in" : "query", "description" : "Filter by text_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[total_charges]", "in" : "query", "description" : "Filter by total_charges (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_last_updated_on]", "in" : "query", "description" : "Filter by device_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_last_updated_on]", "in" : "query", "description" : "Filter by usage_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesFields" }, { "$ref" : "#/components/parameters/WirelessInventoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/vehicles" : { "get" : { "description" : "Retrieve vehicles references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cvn]", "in" : "query", "description" : "Filter by cvn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_year]", "in" : "query", "description" : "Filter by model_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make]", "in" : "query", "description" : "Filter by make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_group]", "in" : "query", "description" : "Filter by model_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vin_number]", "in" : "query", "description" : "Filter by vin_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[license_plate_number]", "in" : "query", "description" : "Filter by license_plate_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a vehicles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/userDataAccesses" : { "get" : { "description" : "Retrieve userDataAccesses references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_districts]", "in" : "query", "description" : "Filter by all_districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_supgroups]", "in" : "query", "description" : "Filter by all_supgroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesFields" }, { "$ref" : "#/components/parameters/UserDataAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/locatorCheckins" : { "get" : { "description" : "Retrieve locatorCheckins references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[checkin_action]", "in" : "query", "description" : "Filter by checkin_action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_version]", "in" : "query", "description" : "Filter by asset_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_on]", "in" : "query", "description" : "Filter by reviewed_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatorCheckinsFields" }, { "$ref" : "#/components/parameters/LocatorCheckinsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a locatorCheckins resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatorCheckinsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/deviceTokens" : { "get" : { "description" : "Retrieve deviceTokens references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_token]", "in" : "query", "description" : "Filter by device_token (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DeviceTokensFields" }, { "$ref" : "#/components/parameters/DeviceTokensInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a deviceTokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a deviceTokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a deviceTokens resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DeviceTokensResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/employeeMessages" : { "get" : { "description" : "Retrieve employeeMessages references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sent_at]", "in" : "query", "description" : "Filter by sent_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_read_at]", "in" : "query", "description" : "Filter by first_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_read_at]", "in" : "query", "description" : "Filter by last_read_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cleared_at]", "in" : "query", "description" : "Filter by cleared_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledged_at]", "in" : "query", "description" : "Filter by acknowledged_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[channel]", "in" : "query", "description" : "Filter by channel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[recipient_email]", "in" : "query", "description" : "Filter by recipient_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_detail]", "in" : "query", "description" : "Filter by delivery_detail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[delivery_attempts]", "in" : "query", "description" : "Filter by delivery_attempts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimed_at]", "in" : "query", "description" : "Filter by claimed_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerInfo]", "in" : "query", "description" : "Filter by schedulerInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messageWithCount]", "in" : "query", "description" : "Filter by messageWithCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeeMessagesFields" }, { "$ref" : "#/components/parameters/EmployeeMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a employeeMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeeMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/messages" : { "get" : { "description" : "Retrieve messages references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subject]", "in" : "query", "description" : "Filter by subject (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_preview]", "in" : "query", "description" : "Filter by message_preview (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_acknowledgement]", "in" : "query", "description" : "Filter by require_acknowledgement (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unreadCount]", "in" : "query", "description" : "Filter by unreadCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[readCount]", "in" : "query", "description" : "Filter by readCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sentCount]", "in" : "query", "description" : "Filter by sentCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledgedCount]", "in" : "query", "description" : "Filter by acknowledgedCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeMessages]", "in" : "query", "description" : "Filter by employeeMessages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/MessagesFields" }, { "$ref" : "#/components/parameters/MessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a messages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/schedulerJobsInfo" : { "get" : { "description" : "Retrieve schedulerJobs references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_group]", "in" : "query", "description" : "Filter by job_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_class]", "in" : "query", "description" : "Filter by job_class (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_expression]", "in" : "query", "description" : "Filter by cron_expression (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repeat_time]", "in" : "query", "description" : "Filter by repeat_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cron_job]", "in" : "query", "description" : "Filter by cron_job (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[time_zone]", "in" : "query", "description" : "Filter by time_zone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parameters]", "in" : "query", "description" : "Filter by parameters (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[jobInfo]", "in" : "query", "description" : "Filter by jobInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobStatus]", "in" : "query", "description" : "Filter by schedulerJobStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SchedulerJobsFields" }, { "$ref" : "#/components/parameters/SchedulerJobsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create employees relationship to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete employees relationship to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update employees relationship to a schedulerJobs resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SchedulerJobsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/investigations" : { "get" : { "description" : "Retrieve investigations references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavationType]", "in" : "query", "description" : "Filter by excavationType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavat]", "in" : "query", "description" : "Filter by excavat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetails]", "in" : "query", "description" : "Filter by investigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersions]", "in" : "query", "description" : "Filter by investigationVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetails]", "in" : "query", "description" : "Filter by cmsInvestigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenEmployee]", "in" : "query", "description" : "Filter by picsTakenEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireAnswers]", "in" : "query", "description" : "Filter by questionnaireAnswers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/comments" : { "get" : { "description" : "Retrieve comments references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[content]", "in" : "query", "description" : "Filter by content (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea_id]", "in" : "query", "description" : "Filter by idea_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[author_id]", "in" : "query", "description" : "Filter by author_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea]", "in" : "query", "description" : "Filter by idea (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CommentsFields" }, { "$ref" : "#/components/parameters/CommentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employees/{id}/relationships/ideas" : { "get" : { "description" : "Retrieve ideas references related to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[title]", "in" : "query", "description" : "Filter by title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[content]", "in" : "query", "description" : "Filter by content (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[kind_id]", "in" : "query", "description" : "Filter by kind_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[author_id]", "in" : "query", "description" : "Filter by author_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_or_rejected_on]", "in" : "query", "description" : "Filter by approved_or_rejected_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_or_rejected_by]", "in" : "query", "description" : "Filter by approved_or_rejected_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[kind]", "in" : "query", "description" : "Filter by kind (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[comments]", "in" : "query", "description" : "Filter by comments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[votes]", "in" : "query", "description" : "Filter by votes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/IdeasFields" }, { "$ref" : "#/components/parameters/IdeasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/dueDateExtensions/{id}" : { "get" : { "description" : "Retrieve a dueDateExtensions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsPrimaryKey" }, { "$ref" : "#/components/parameters/DueDateExtensionsFields" }, { "$ref" : "#/components/parameters/DueDateExtensionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DueDateExtensionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a DueDateExtensions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a DueDateExtensions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DueDateExtensionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/dueDateExtensions" : { "get" : { "description" : "Retrieve a List of dueDateExtensions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr_id]", "in" : "query", "description" : "Filter by usr_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_extended]", "in" : "query", "description" : "Filter by when_extended (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[due_date]", "in" : "query", "description" : "Filter by due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver_phone]", "in" : "query", "description" : "Filter by approver_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[old_due_date]", "in" : "query", "description" : "Filter by old_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[when_entered]", "in" : "query", "description" : "Filter by when_entered (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usr]", "in" : "query", "description" : "Filter by usr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsFields" }, { "$ref" : "#/components/parameters/DueDateExtensionsInclude" }, { "$ref" : "#/components/parameters/DueDateExtensionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DueDateExtensionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a DueDateExtensions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DueDateExtensionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DueDateExtensionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/dueDateExtensions/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a dueDateExtensions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/dueDateExtensions/{id}/usr" : { "get" : { "description" : "Retrieve usrs related to a dueDateExtensions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsPrimaryKey" }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/dueDateExtensions/{id}/visit" : { "get" : { "description" : "Retrieve visits related to a dueDateExtensions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsPrimaryKey" }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourceResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/dueDateExtensions/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a dueDateExtensions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/dueDateExtensions/{id}/relationships/usr" : { "get" : { "description" : "Retrieve usrs references related to a dueDateExtensions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsPrimaryKey" }, { "$ref" : "#/components/parameters/UsrsFields" }, { "$ref" : "#/components/parameters/UsrsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UsrsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/dueDateExtensions/{id}/relationships/visit" : { "get" : { "description" : "Retrieve visits references related to a dueDateExtensions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DueDateExtensionsPrimaryKey" }, { "$ref" : "#/components/parameters/VisitsFields" }, { "$ref" : "#/components/parameters/VisitsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VisitsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/VisitsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}" : { "get" : { "description" : "Retrieve a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a LocateClosedSnapshots", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a LocateClosedSnapshots", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots" : { "get" : { "description" : "Retrieve a List of locateClosedSnapshots resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsFields" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsInclude" }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a LocateClosedSnapshots", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LocateClosedSnapshotsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/bucket" : { "get" : { "description" : "Retrieve buckets related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/transmissionExtra" : { "get" : { "description" : "Retrieve transmissionExtras related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/transmission" : { "get" : { "description" : "Retrieve transmissions related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/latestActivity" : { "get" : { "description" : "Retrieve activities related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/firstClosingActivity" : { "get" : { "description" : "Retrieve activities related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/term" : { "get" : { "description" : "Retrieve terms related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/termUtilityMap" : { "get" : { "description" : "Retrieve termUtilityMaps related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TermUtilityMapsFields" }, { "$ref" : "#/components/parameters/TermUtilityMapsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermUtilityMapsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/activities" : { "get" : { "description" : "Retrieve activities related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/projectTicket" : { "get" : { "description" : "Retrieve projectTickets related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/utility" : { "get" : { "description" : "Retrieve utilities related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/bucket" : { "get" : { "description" : "Retrieve buckets references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/BucketsFields" }, { "$ref" : "#/components/parameters/BucketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/BucketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/BucketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmissionDetail" : { "get" : { "description" : "Retrieve transmissionsDetail references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmissionExtra" : { "get" : { "description" : "Retrieve transmissionExtras references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionExtrasFields" }, { "$ref" : "#/components/parameters/TransmissionExtrasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionExtrasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmission" : { "get" : { "description" : "Retrieve transmissions references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/latestActivity" : { "get" : { "description" : "Retrieve activities references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/firstClosingActivity" : { "get" : { "description" : "Retrieve activities references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/term" : { "get" : { "description" : "Retrieve terms references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TermsFields" }, { "$ref" : "#/components/parameters/TermsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TermsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/termUtilityMap" : { "get" : { "description" : "Retrieve termUtilityMaps references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/TermUtilityMapsFields" }, { "$ref" : "#/components/parameters/TermUtilityMapsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TermUtilityMapsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/activities" : { "get" : { "description" : "Retrieve activities references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feet_located]", "in" : "query", "description" : "Filter by feet_located (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[hours_worked]", "in" : "query", "description" : "Filter by hours_worked (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_override]", "in" : "query", "description" : "Filter by billable_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed]", "in" : "query", "description" : "Filter by billed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closing_override]", "in" : "query", "description" : "Filter by closing_override (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[relevant]", "in" : "query", "description" : "Filter by relevant (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_id]", "in" : "query", "description" : "Filter by locate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit_id]", "in" : "query", "description" : "Filter by visit_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[addresses_count]", "in" : "query", "description" : "Filter by addresses_count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wire_center]", "in" : "query", "description" : "Filter by wire_center (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[export_status]", "in" : "query", "description" : "Filter by export_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate]", "in" : "query", "description" : "Filter by locate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateOpenSnapshot]", "in" : "query", "description" : "Filter by locateOpenSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locateClosedSnapshot]", "in" : "query", "description" : "Filter by locateClosedSnapshot (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[statusCode]", "in" : "query", "description" : "Filter by statusCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visit]", "in" : "query", "description" : "Filter by visit (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingLocate]", "in" : "query", "description" : "Filter by firstClosingLocate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[responseLogs]", "in" : "query", "description" : "Filter by responseLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ActivitiesFields" }, { "$ref" : "#/components/parameters/ActivitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ActivitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/projectTicket" : { "get" : { "description" : "Retrieve projectTickets references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/ProjectTicketsFields" }, { "$ref" : "#/components/parameters/ProjectTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ProjectTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/utility" : { "get" : { "description" : "Retrieve utilities references related to a locateClosedSnapshots resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LocateClosedSnapshotsPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesFields" }, { "$ref" : "#/components/parameters/UtilitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/openTicket/{id}" : { "get" : { "description" : "Retrieve a openTickets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/OpenTicketsPrimaryKey" }, { "$ref" : "#/components/parameters/OpenTicketsFields" }, { "$ref" : "#/components/parameters/OpenTicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/OpenTicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/OpenTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a OpenTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/OpenTicketsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/OpenTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a OpenTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/OpenTicketsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OpenTicketsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/OpenTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/openTicket" : { "get" : { "description" : "Retrieve a List of openTickets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count]", "in" : "query", "description" : "Filter by count (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/OpenTicketsFields" }, { "$ref" : "#/components/parameters/OpenTicketsInclude" }, { "$ref" : "#/components/parameters/OpenTicketsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/OpenTicketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/OpenTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a OpenTickets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OpenTicketsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OpenTicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/OpenTicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}" : { "get" : { "description" : "Retrieve a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a EmployeesOnLoan", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a EmployeesOnLoan", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan" : { "get" : { "description" : "Retrieve a List of employeesOnLoan resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" }, { "$ref" : "#/components/parameters/EmployeesOnLoanSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a EmployeesOnLoan", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/dist" : { "get" : { "description" : "Retrieve districts related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/assetAssignments" : { "get" : { "description" : "Retrieve assetAssignments related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/vehicles" : { "get" : { "description" : "Retrieve vehicles related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cvn]", "in" : "query", "description" : "Filter by cvn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_year]", "in" : "query", "description" : "Filter by model_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make]", "in" : "query", "description" : "Filter by make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_group]", "in" : "query", "description" : "Filter by model_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vin_number]", "in" : "query", "description" : "Filter by vin_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[license_plate_number]", "in" : "query", "description" : "Filter by license_plate_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/wirelessInventories" : { "get" : { "description" : "Retrieve wirelessInventories related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_number]", "in" : "query", "description" : "Filter by wireless_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_vendor]", "in" : "query", "description" : "Filter by wireless_vendor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_full_name]", "in" : "query", "description" : "Filter by wireless_user_full_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_status]", "in" : "query", "description" : "Filter by wireless_user_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[truck_vin]", "in" : "query", "description" : "Filter by truck_vin (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imei]", "in" : "query", "description" : "Filter by imei (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sim_number]", "in" : "query", "description" : "Filter by sim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_model]", "in" : "query", "description" : "Filter by device_model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_end_date]", "in" : "query", "description" : "Filter by contract_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_usage]", "in" : "query", "description" : "Filter by data_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voice_usage]", "in" : "query", "description" : "Filter by voice_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[text_usage]", "in" : "query", "description" : "Filter by text_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[total_charges]", "in" : "query", "description" : "Filter by total_charges (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_last_updated_on]", "in" : "query", "description" : "Filter by device_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_last_updated_on]", "in" : "query", "description" : "Filter by usage_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesFields" }, { "$ref" : "#/components/parameters/WirelessInventoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WirelessInventoriesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/relationships/dist" : { "get" : { "description" : "Retrieve districts references related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/relationships/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups references related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/relationships/assetAssignments" : { "get" : { "description" : "Retrieve assetAssignments references related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/relationships/vehicles" : { "get" : { "description" : "Retrieve vehicles references related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cvn]", "in" : "query", "description" : "Filter by cvn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_year]", "in" : "query", "description" : "Filter by model_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make]", "in" : "query", "description" : "Filter by make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_group]", "in" : "query", "description" : "Filter by model_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vin_number]", "in" : "query", "description" : "Filter by vin_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[license_plate_number]", "in" : "query", "description" : "Filter by license_plate_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesOnLoan/{id}/relationships/wirelessInventories" : { "get" : { "description" : "Retrieve wirelessInventories references related to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_number]", "in" : "query", "description" : "Filter by wireless_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_vendor]", "in" : "query", "description" : "Filter by wireless_vendor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_full_name]", "in" : "query", "description" : "Filter by wireless_user_full_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wireless_user_status]", "in" : "query", "description" : "Filter by wireless_user_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[truck_vin]", "in" : "query", "description" : "Filter by truck_vin (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imei]", "in" : "query", "description" : "Filter by imei (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sim_number]", "in" : "query", "description" : "Filter by sim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_model]", "in" : "query", "description" : "Filter by device_model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_end_date]", "in" : "query", "description" : "Filter by contract_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_usage]", "in" : "query", "description" : "Filter by data_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[voice_usage]", "in" : "query", "description" : "Filter by voice_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[text_usage]", "in" : "query", "description" : "Filter by text_usage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[total_charges]", "in" : "query", "description" : "Filter by total_charges (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_last_updated_on]", "in" : "query", "description" : "Filter by device_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usage_last_updated_on]", "in" : "query", "description" : "Filter by usage_last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WirelessInventoriesFields" }, { "$ref" : "#/components/parameters/WirelessInventoriesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/WirelessInventoriesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotificationsArchives/{id}" : { "get" : { "description" : "Retrieve a wfNotificationsArchives resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsArchivesPrimaryKey" }, { "$ref" : "#/components/parameters/WfNotificationsArchivesFields" }, { "$ref" : "#/components/parameters/WfNotificationsArchivesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourceResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a WfNotificationsArchives", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsArchivesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a WfNotificationsArchives", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsArchivesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsArchivesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotificationsArchives" : { "get" : { "description" : "Retrieve a List of wfNotificationsArchives resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notification_id]", "in" : "query", "description" : "Filter by notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[process_id]", "in" : "query", "description" : "Filter by process_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_id]", "in" : "query", "description" : "Filter by activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[step_id]", "in" : "query", "description" : "Filter by step_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idType]", "in" : "query", "description" : "Filter by idType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id_column_table]", "in" : "query", "description" : "Filter by id_column_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activity_name]", "in" : "query", "description" : "Filter by activity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[text]", "in" : "query", "description" : "Filter by text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[next_step_url]", "in" : "query", "description" : "Filter by next_step_url (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idvalue]", "in" : "query", "description" : "Filter by idvalue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[result]", "in" : "query", "description" : "Filter by result (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[remarks]", "in" : "query", "description" : "Filter by remarks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[archive_date]", "in" : "query", "description" : "Filter by archive_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wfNotification]", "in" : "query", "description" : "Filter by wfNotification (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/WfNotificationsArchivesFields" }, { "$ref" : "#/components/parameters/WfNotificationsArchivesInclude" }, { "$ref" : "#/components/parameters/WfNotificationsArchivesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a WfNotificationsArchives", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsArchivesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/WfNotificationsArchivesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotificationsArchives/{id}/wfNotification" : { "get" : { "description" : "Retrieve wfNotifications related to a wfNotificationsArchives resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsArchivesPrimaryKey" }, { "$ref" : "#/components/parameters/WfNotificationsFields" }, { "$ref" : "#/components/parameters/WfNotificationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/wfNotificationsArchives/{id}/relationships/wfNotification" : { "get" : { "description" : "Retrieve wfNotifications references related to a wfNotificationsArchives resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/WfNotificationsArchivesPrimaryKey" }, { "$ref" : "#/components/parameters/WfNotificationsFields" }, { "$ref" : "#/components/parameters/WfNotificationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/WfNotificationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/WfNotificationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevices/{id}" : { "get" : { "description" : "Retrieve a pumpDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/PumpDevicesFields" }, { "$ref" : "#/components/parameters/PumpDevicesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PumpDevicesResourceResponse" }, "202" : { "$ref" : "#/components/responses/PumpDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a PumpDevices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/PumpDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a PumpDevices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDevicesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PumpDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevices" : { "get" : { "description" : "Retrieve a List of pumpDevices resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pump_date]", "in" : "query", "description" : "Filter by pump_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[safety_screen_triggers_24]", "in" : "query", "description" : "Filter by safety_screen_triggers_24 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[safety_screen_version]", "in" : "query", "description" : "Filter by safety_screen_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model]", "in" : "query", "description" : "Filter by model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[host_name]", "in" : "query", "description" : "Filter by host_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[os_name]", "in" : "query", "description" : "Filter by os_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[os_version]", "in" : "query", "description" : "Filter by os_version (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ip_address]", "in" : "query", "description" : "Filter by ip_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[free_space]", "in" : "query", "description" : "Filter by free_space (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[memory]", "in" : "query", "description" : "Filter by memory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile_number]", "in" : "query", "description" : "Filter by mobile_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imei]", "in" : "query", "description" : "Filter by imei (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[imed]", "in" : "query", "description" : "Filter by imed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[available_gps_ports]", "in" : "query", "description" : "Filter by available_gps_ports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_gps_lock]", "in" : "query", "description" : "Filter by last_gps_lock (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PumpDevicesFields" }, { "$ref" : "#/components/parameters/PumpDevicesInclude" }, { "$ref" : "#/components/parameters/PumpDevicesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PumpDevicesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PumpDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a PumpDevices", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDevicesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDevicesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PumpDevicesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevices/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a pumpDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create pumpDevices relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete pumpDevices relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update pumpDevices relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevices/{id}/asset" : { "get" : { "description" : "Retrieve assets related to a pumpDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create pumpDevices relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete pumpDevices relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update pumpDevices relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevices/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a pumpDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create pumpDevices relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete pumpDevices relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update pumpDevices relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/pumpDevices/{id}/relationships/asset" : { "get" : { "description" : "Retrieve assets references related to a pumpDevices resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create pumpDevices relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete pumpDevices relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update pumpDevices relationship to a assets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PumpDevicesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}" : { "get" : { "description" : "Retrieve a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CmsInvestigationDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CmsInvestigationDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails" : { "get" : { "description" : "Retrieve a List of cmsInvestigationDetails resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_root_cause_id]", "in" : "query", "description" : "Filter by investigation_root_cause_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor_id]", "in" : "query", "description" : "Filter by supervisor_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[event_summary]", "in" : "query", "description" : "Filter by event_summary (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[video_url]", "in" : "query", "description" : "Filter by video_url (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_report_attachment_id]", "in" : "query", "description" : "Filter by inv_report_attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailLines]", "in" : "query", "description" : "Filter by investigationDetailLines (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationReport]", "in" : "query", "description" : "Filter by investigationReport (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utilitiesProfilesView]", "in" : "query", "description" : "Filter by utilitiesProfilesView (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsFields" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsInclude" }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CmsInvestigationDetails", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CmsInvestigationDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/customer" : { "get" : { "description" : "Retrieve customers related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/investigation" : { "get" : { "description" : "Retrieve investigations related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/estimates" : { "get" : { "description" : "Retrieve estimates related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/investigationDetailLines" : { "get" : { "description" : "Retrieve investigationDetailLines related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_sent]", "in" : "query", "description" : "Filter by report_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_to_customer]", "in" : "query", "description" : "Filter by billable_to_customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_date]", "in" : "query", "description" : "Filter by accepted_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_sent_date]", "in" : "query", "description" : "Filter by report_sent_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_id]", "in" : "query", "description" : "Filter by contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cdc_code]", "in" : "query", "description" : "Filter by cdc_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjuster_time]", "in" : "query", "description" : "Filter by adjuster_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailLinesFields" }, { "$ref" : "#/components/parameters/InvestigationDetailLinesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/investigationReport" : { "get" : { "description" : "Retrieve damagePhotos related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagePhotosFields" }, { "$ref" : "#/components/parameters/DamagePhotosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create cmsInvestigationDetails relationship to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete cmsInvestigationDetails relationship to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update cmsInvestigationDetails relationship to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/utilitiesProfilesView" : { "get" : { "description" : "Retrieve utilitiesProfiles related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesProfilesFields" }, { "$ref" : "#/components/parameters/UtilitiesProfilesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/relationships/customer" : { "get" : { "description" : "Retrieve customers references related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/relationships/investigation" : { "get" : { "description" : "Retrieve investigations references related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/relationships/estimates" : { "get" : { "description" : "Retrieve estimates references related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/relationships/investigationDetailLines" : { "get" : { "description" : "Retrieve investigationDetailLines references related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[detail_id]", "in" : "query", "description" : "Filter by detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_sent]", "in" : "query", "description" : "Filter by report_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billable_to_customer]", "in" : "query", "description" : "Filter by billable_to_customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_date]", "in" : "query", "description" : "Filter by accepted_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_sent_date]", "in" : "query", "description" : "Filter by report_sent_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1]", "in" : "query", "description" : "Filter by att1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2]", "in" : "query", "description" : "Filter by att2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3]", "in" : "query", "description" : "Filter by att3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att4]", "in" : "query", "description" : "Filter by att4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att5]", "in" : "query", "description" : "Filter by att5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_id]", "in" : "query", "description" : "Filter by contract_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cdc_code]", "in" : "query", "description" : "Filter by cdc_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjuster_time]", "in" : "query", "description" : "Filter by adjuster_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationDetailLinesFields" }, { "$ref" : "#/components/parameters/InvestigationDetailLinesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationDetailLinesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/relationships/investigationReport" : { "get" : { "description" : "Retrieve damagePhotos references related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/DamagePhotosFields" }, { "$ref" : "#/components/parameters/DamagePhotosInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create cmsInvestigationDetails relationship to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete cmsInvestigationDetails relationship to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update cmsInvestigationDetails relationship to a damagePhotos resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DamagePhotosResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DamagePhotosResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/cmsInvestigationDetails/{id}/relationships/utilitiesProfilesView" : { "get" : { "description" : "Retrieve utilitiesProfiles references related to a cmsInvestigationDetails resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CmsInvestigationDetailsPrimaryKey" }, { "$ref" : "#/components/parameters/UtilitiesProfilesFields" }, { "$ref" : "#/components/parameters/UtilitiesProfilesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/UtilitiesProfilesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}" : { "get" : { "description" : "Retrieve a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TransmissionsDetail", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TransmissionsDetail", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsDetailPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail" : { "get" : { "description" : "Retrieve a List of transmissionsDetail resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sourcefilename]", "in" : "query", "description" : "Filter by sourcefilename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_address_1]", "in" : "query", "description" : "Filter by excavator_address_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_city]", "in" : "query", "description" : "Filter by excavator_city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[maplocation]", "in" : "query", "description" : "Filter by maplocation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapbook]", "in" : "query", "description" : "Filter by mapbook (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickets]", "in" : "query", "description" : "Filter by tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[digAreas]", "in" : "query", "description" : "Filter by digAreas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailFields" }, { "$ref" : "#/components/parameters/TransmissionsDetailInclude" }, { "$ref" : "#/components/parameters/TransmissionsDetailSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsDetailResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TransmissionsDetail", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsDetailPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionsDetailResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/tickets" : { "get" : { "description" : "Retrieve tickets related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticketsInfo]", "in" : "query", "description" : "Filter by ticketsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachments]", "in" : "query", "description" : "Filter by tkpAttachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentsCategorized]", "in" : "query", "description" : "Filter by attachmentsCategorized (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachmentsWithNotifications]", "in" : "query", "description" : "Filter by tkpAttachmentsWithNotifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkedTickets]", "in" : "query", "description" : "Filter by linkedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/locates" : { "get" : { "description" : "Retrieve locates related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/digAreas" : { "get" : { "description" : "Retrieve digAreas related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[order_number]", "in" : "query", "description" : "Filter by order_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[group_index]", "in" : "query", "description" : "Filter by group_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DigAreasFields" }, { "$ref" : "#/components/parameters/DigAreasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DigAreasResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DigAreasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/relationships/transmissionBase" : { "get" : { "description" : "Retrieve transmissionsBase references related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsBaseFields" }, { "$ref" : "#/components/parameters/TransmissionsBaseInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsBaseResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/relationships/transmissionText" : { "get" : { "description" : "Retrieve transmissionsText references related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsTextFields" }, { "$ref" : "#/components/parameters/TransmissionsTextInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsTextResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/relationships/tickets" : { "get" : { "description" : "Retrieve tickets references related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticketsInfo]", "in" : "query", "description" : "Filter by ticketsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachments]", "in" : "query", "description" : "Filter by tkpAttachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentsCategorized]", "in" : "query", "description" : "Filter by attachmentsCategorized (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachmentsWithNotifications]", "in" : "query", "description" : "Filter by tkpAttachmentsWithNotifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkedTickets]", "in" : "query", "description" : "Filter by linkedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/relationships/locates" : { "get" : { "description" : "Retrieve locates references related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissionsDetail/{id}/relationships/digAreas" : { "get" : { "description" : "Retrieve digAreas references related to a transmissionsDetail resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsDetailPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[order_number]", "in" : "query", "description" : "Filter by order_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[group_index]", "in" : "query", "description" : "Filter by group_index (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DigAreasFields" }, { "$ref" : "#/components/parameters/DigAreasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DigAreasResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DigAreasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/usrRoles/{id}" : { "get" : { "description" : "Retrieve a usrRoles resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrRolesPrimaryKey" }, { "$ref" : "#/components/parameters/UsrRolesFields" }, { "$ref" : "#/components/parameters/UsrRolesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrRolesResourceResponse" }, "202" : { "$ref" : "#/components/responses/UsrRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UsrRoles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrRolesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UsrRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UsrRoles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UsrRolesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrRolesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UsrRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/usrRoles" : { "get" : { "description" : "Retrieve a List of usrRoles resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UsrRolesFields" }, { "$ref" : "#/components/parameters/UsrRolesInclude" }, { "$ref" : "#/components/parameters/UsrRolesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UsrRolesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UsrRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UsrRoles", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrRolesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrRolesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UsrRolesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}" : { "get" : { "description" : "Retrieve a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Districts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Districts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts" : { "get" : { "description" : "Retrieve a List of districts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_code]", "in" : "query", "description" : "Filter by district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_name]", "in" : "query", "description" : "Filter by district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_manager_employee_id]", "in" : "query", "description" : "Filter by district_manager_employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employees]", "in" : "query", "description" : "Filter by employees (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesOnLoans]", "in" : "query", "description" : "Filter by employeesOnLoans (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAssets]", "in" : "query", "description" : "Filter by employeesActiveNoAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisorGroups]", "in" : "query", "description" : "Filter by supervisorGroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userDataAccesses]", "in" : "query", "description" : "Filter by userDataAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locations]", "in" : "query", "description" : "Filter by locations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" }, { "$ref" : "#/components/parameters/DistrictsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Districts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/employees" : { "get" : { "description" : "Retrieve employees related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action]", "in" : "query", "description" : "Filter by action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimated_return_date]", "in" : "query", "description" : "Filter by estimated_return_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[announcements]", "in" : "query", "description" : "Filter by announcements (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignments]", "in" : "query", "description" : "Filter by assignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[requests]", "in" : "query", "description" : "Filter by requests (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acceptedAssets]", "in" : "query", "description" : "Filter by acceptedAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userDataAccesses]", "in" : "query", "description" : "Filter by userDataAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deviceTokens]", "in" : "query", "description" : "Filter by deviceTokens (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeMessages]", "in" : "query", "description" : "Filter by employeeMessages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messages]", "in" : "query", "description" : "Filter by messages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobsInfo]", "in" : "query", "description" : "Filter by schedulerJobsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigations]", "in" : "query", "description" : "Filter by investigations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[comments]", "in" : "query", "description" : "Filter by comments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ideas]", "in" : "query", "description" : "Filter by ideas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/employeesOnLoans" : { "get" : { "description" : "Retrieve employeesOnLoan related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/employeesActiveNoAssets" : { "get" : { "description" : "Retrieve employeesActiveNoAssets related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/supervisorGroups" : { "get" : { "description" : "Retrieve supervisorGroups related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_code]", "in" : "query", "description" : "Filter by district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_name]", "in" : "query", "description" : "Filter by district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employees]", "in" : "query", "description" : "Filter by employees (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesOnLoan]", "in" : "query", "description" : "Filter by employeesOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/assets" : { "get" : { "description" : "Retrieve assets related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/districtLocations" : { "get" : { "description" : "Retrieve districtLocations related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsFields" }, { "$ref" : "#/components/parameters/DistrictLocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/userDataAccesses" : { "get" : { "description" : "Retrieve userDataAccesses related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_districts]", "in" : "query", "description" : "Filter by all_districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_supgroups]", "in" : "query", "description" : "Filter by all_supgroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesFields" }, { "$ref" : "#/components/parameters/UserDataAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/locations" : { "get" : { "description" : "Retrieve locations related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_type_id]", "in" : "query", "description" : "Filter by location_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_id]", "in" : "query", "description" : "Filter by country_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districts]", "in" : "query", "description" : "Filter by districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/relationships/employees" : { "get" : { "description" : "Retrieve employees references related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[action]", "in" : "query", "description" : "Filter by action (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reason]", "in" : "query", "description" : "Filter by reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimated_return_date]", "in" : "query", "description" : "Filter by estimated_return_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[announcements]", "in" : "query", "description" : "Filter by announcements (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignments]", "in" : "query", "description" : "Filter by assignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[requests]", "in" : "query", "description" : "Filter by requests (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acceptedAssets]", "in" : "query", "description" : "Filter by acceptedAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[userDataAccesses]", "in" : "query", "description" : "Filter by userDataAccesses (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deviceTokens]", "in" : "query", "description" : "Filter by deviceTokens (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeMessages]", "in" : "query", "description" : "Filter by employeeMessages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[messages]", "in" : "query", "description" : "Filter by messages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[schedulerJobsInfo]", "in" : "query", "description" : "Filter by schedulerJobsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigations]", "in" : "query", "description" : "Filter by investigations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[comments]", "in" : "query", "description" : "Filter by comments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ideas]", "in" : "query", "description" : "Filter by ideas (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a employees resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/relationships/employeesOnLoans" : { "get" : { "description" : "Retrieve employeesOnLoan references related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wirelessInventories]", "in" : "query", "description" : "Filter by wirelessInventories (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesOnLoanFields" }, { "$ref" : "#/components/parameters/EmployeesOnLoanInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a employeesOnLoan resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesOnLoanResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/relationships/employeesActiveNoAssets" : { "get" : { "description" : "Retrieve employeesActiveNoAssets references related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/relationships/supervisorGroups" : { "get" : { "description" : "Retrieve supervisorGroups references related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_code]", "in" : "query", "description" : "Filter by district_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_name]", "in" : "query", "description" : "Filter by district_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employees]", "in" : "query", "description" : "Filter by employees (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesOnLoan]", "in" : "query", "description" : "Filter by employeesOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a supervisorGroups resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/relationships/assets" : { "get" : { "description" : "Retrieve assets references related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_date]", "in" : "query", "description" : "Filter by purchase_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purchase_price]", "in" : "query", "description" : "Filter by purchase_price (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tax]", "in" : "query", "description" : "Filter by tax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty]", "in" : "query", "description" : "Filter by warranty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_start_date]", "in" : "query", "description" : "Filter by warranty_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[warranty_end_date]", "in" : "query", "description" : "Filter by warranty_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletion_reason_id]", "in" : "query", "description" : "Filter by deletion_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_tag]", "in" : "query", "description" : "Filter by usic_tag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[source_system]", "in" : "query", "description" : "Filter by source_system (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapping_id]", "in" : "query", "description" : "Filter by mapping_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[in_transfer]", "in" : "query", "description" : "Filter by in_transfer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accepted_by_id]", "in" : "query", "description" : "Filter by accepted_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup_code]", "in" : "query", "description" : "Filter by supgroup_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[organization_id]", "in" : "query", "description" : "Filter by organization_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_id]", "in" : "query", "description" : "Filter by workday_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tracking_no]", "in" : "query", "description" : "Filter by tracking_no (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[police_report_number]", "in" : "query", "description" : "Filter by police_report_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repair_reason_id]", "in" : "query", "description" : "Filter by repair_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_address]", "in" : "query", "description" : "Filter by loss_address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_description]", "in" : "query", "description" : "Filter by loss_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loss_date]", "in" : "query", "description" : "Filter by loss_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_creation_date]", "in" : "query", "description" : "Filter by original_creation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reference_id]", "in" : "query", "description" : "Filter by reference_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[deletionType]", "in" : "query", "description" : "Filter by deletionType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[repairReason]", "in" : "query", "description" : "Filter by repairReason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locatorCheckins]", "in" : "query", "description" : "Filter by locatorCheckins (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetStatus]", "in" : "query", "description" : "Filter by assetStatus (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMapping]", "in" : "query", "description" : "Filter by categoryTypeMakeMapping (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeAcceptedBy]", "in" : "query", "description" : "Filter by employeeAcceptedBy (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignment]", "in" : "query", "description" : "Filter by assetAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lastAssignment]", "in" : "query", "description" : "Filter by lastAssignment (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttributeValues]", "in" : "query", "description" : "Filter by assetAttributeValues (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[netmotionDevices]", "in" : "query", "description" : "Filter by netmotionDevices (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/relationships/districtLocations" : { "get" : { "description" : "Retrieve districtLocations references related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_id]", "in" : "query", "description" : "Filter by location_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location]", "in" : "query", "description" : "Filter by location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/DistrictLocationsFields" }, { "$ref" : "#/components/parameters/DistrictLocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a districtLocations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/DistrictLocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/relationships/userDataAccesses" : { "get" : { "description" : "Retrieve userDataAccesses references related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_districts]", "in" : "query", "description" : "Filter by all_districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[all_supgroups]", "in" : "query", "description" : "Filter by all_supgroups (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserDataAccessesFields" }, { "$ref" : "#/components/parameters/UserDataAccessesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a userDataAccesses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/UserDataAccessesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/districts/{id}/relationships/locations" : { "get" : { "description" : "Retrieve locations references related to a districts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[location_type_id]", "in" : "query", "description" : "Filter by location_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address1]", "in" : "query", "description" : "Filter by address1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address2]", "in" : "query", "description" : "Filter by address2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state_id]", "in" : "query", "description" : "Filter by state_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country_id]", "in" : "query", "description" : "Filter by country_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[phone]", "in" : "query", "description" : "Filter by phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mobile]", "in" : "query", "description" : "Filter by mobile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[fax]", "in" : "query", "description" : "Filter by fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contact_name]", "in" : "query", "description" : "Filter by contact_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districtLocations]", "in" : "query", "description" : "Filter by districtLocations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[country]", "in" : "query", "description" : "Filter by country (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[districts]", "in" : "query", "description" : "Filter by districts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocationsFields" }, { "$ref" : "#/components/parameters/LocationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create districts relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete districts relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update districts relationship to a locations resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/DistrictsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userPermissions/{id}" : { "get" : { "description" : "Retrieve a userPermissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserPermissionsPrimaryKey" }, { "$ref" : "#/components/parameters/UserPermissionsFields" }, { "$ref" : "#/components/parameters/UserPermissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserPermissionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/UserPermissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a UserPermissions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserPermissionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/UserPermissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a UserPermissions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/UserPermissionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserPermissionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserPermissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/userPermissions" : { "get" : { "description" : "Retrieve a List of userPermissions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_permission_id]", "in" : "query", "description" : "Filter by cp_permission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cp_user_id]", "in" : "query", "description" : "Filter by cp_user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_start_date]", "in" : "query", "description" : "Filter by eff_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_end_date]", "in" : "query", "description" : "Filter by eff_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/UserPermissionsFields" }, { "$ref" : "#/components/parameters/UserPermissionsInclude" }, { "$ref" : "#/components/parameters/UserPermissionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/UserPermissionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/UserPermissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a UserPermissions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserPermissionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserPermissionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/UserPermissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessages/{id}" : { "get" : { "description" : "Retrieve a smsMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/SmsMessagesFields" }, { "$ref" : "#/components/parameters/SmsMessagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourceResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a SmsMessages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessagesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a SmsMessages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessagesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessages" : { "get" : { "description" : "Retrieve a List of smsMessages resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[smsMessageLogs]", "in" : "query", "description" : "Filter by smsMessageLogs (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SmsMessagesFields" }, { "$ref" : "#/components/parameters/SmsMessagesInclude" }, { "$ref" : "#/components/parameters/SmsMessagesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a SmsMessages", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/SmsMessagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessages/{id}/smsMessageLogs" : { "get" : { "description" : "Retrieve smsMessageLogs related to a smsMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_id]", "in" : "query", "description" : "Filter by device_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_code]", "in" : "query", "description" : "Filter by status_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[smsMessage]", "in" : "query", "description" : "Filter by smsMessage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsFields" }, { "$ref" : "#/components/parameters/SmsMessageLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessageLogsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessageLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/smsMessages/{id}/relationships/smsMessageLogs" : { "get" : { "description" : "Retrieve smsMessageLogs references related to a smsMessages resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/SmsMessagesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_id]", "in" : "query", "description" : "Filter by message_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[device_id]", "in" : "query", "description" : "Filter by device_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_code]", "in" : "query", "description" : "Filter by status_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[smsMessage]", "in" : "query", "description" : "Filter by smsMessage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/SmsMessageLogsFields" }, { "$ref" : "#/components/parameters/SmsMessageLogsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SmsMessageLogsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/SmsMessageLogsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/attachmentEntities/{id}" : { "get" : { "description" : "Retrieve a attachEntities resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachEntitiesPrimaryKey" }, { "$ref" : "#/components/parameters/AttachEntitiesFields" }, { "$ref" : "#/components/parameters/AttachEntitiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AttachEntities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachEntitiesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AttachEntities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachEntitiesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/attachmentEntities" : { "get" : { "description" : "Retrieve a List of attachEntities resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_name]", "in" : "query", "description" : "Filter by attachment_entity_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[entity_table]", "in" : "query", "description" : "Filter by entity_table (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachEntitiesFields" }, { "$ref" : "#/components/parameters/AttachEntitiesInclude" }, { "$ref" : "#/components/parameters/AttachEntitiesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachEntitiesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AttachEntities", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachEntitiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/comments/{id}" : { "get" : { "description" : "Retrieve a comments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CommentsPrimaryKey" }, { "$ref" : "#/components/parameters/CommentsFields" }, { "$ref" : "#/components/parameters/CommentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CommentsResourceResponse" }, "202" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Comments", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CommentsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Comments", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CommentsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CommentsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/comments" : { "get" : { "description" : "Retrieve a List of comments resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[content]", "in" : "query", "description" : "Filter by content (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea_id]", "in" : "query", "description" : "Filter by idea_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[author_id]", "in" : "query", "description" : "Filter by author_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[idea]", "in" : "query", "description" : "Filter by idea (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CommentsFields" }, { "$ref" : "#/components/parameters/CommentsInclude" }, { "$ref" : "#/components/parameters/CommentsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CommentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Comments", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CommentsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CommentsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CommentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/comments/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a comments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CommentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/comments/{id}/idea" : { "get" : { "description" : "Retrieve ideas related to a comments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CommentsPrimaryKey" }, { "$ref" : "#/components/parameters/IdeasFields" }, { "$ref" : "#/components/parameters/IdeasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeasResourceResponse" }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/comments/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a comments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CommentsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/idea/1.0/comments/{id}/relationships/idea" : { "get" : { "description" : "Retrieve ideas references related to a comments resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CommentsPrimaryKey" }, { "$ref" : "#/components/parameters/IdeasFields" }, { "$ref" : "#/components/parameters/IdeasInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/IdeasResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/IdeasResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractStates/{id}" : { "get" : { "description" : "Retrieve a customerContractStates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomerContractStatesFields" }, { "$ref" : "#/components/parameters/CustomerContractStatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractStatesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a CustomerContractStates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/CustomerContractStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a CustomerContractStates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractStatesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerContractStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractStates" : { "get" : { "description" : "Retrieve a List of customerContractStates resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesFields" }, { "$ref" : "#/components/parameters/CustomerContractStatesInclude" }, { "$ref" : "#/components/parameters/CustomerContractStatesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomerContractStatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CustomerContractStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a CustomerContractStates", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractStatesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractStatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/CustomerContractStatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractStates/{id}/customer" : { "get" : { "description" : "Retrieve customers related to a customerContractStates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerContractStates relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerContractStates relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerContractStates relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/customerportal/1.0/customerContractStates/{id}/relationships/customer" : { "get" : { "description" : "Retrieve customers references related to a customerContractStates resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" }, { "$ref" : "#/components/parameters/CustomersFields" }, { "$ref" : "#/components/parameters/CustomersInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create customerContractStates relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete customerContractStates relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update customerContractStates relationship to a customers resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/CustomerContractStatesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/CustomersResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CustomersResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}" : { "get" : { "description" : "Retrieve a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a LegalCases", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a LegalCases", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalCasesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases" : { "get" : { "description" : "Retrieve a List of legalCases resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_type_id]", "in" : "query", "description" : "Filter by cases_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cases_sub_type_id]", "in" : "query", "description" : "Filter by cases_sub_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_manager_id]", "in" : "query", "description" : "Filter by case_manager_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_adjuster_id]", "in" : "query", "description" : "Filter by insurance_adjuster_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_id]", "in" : "query", "description" : "Filter by law_firm_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_party_id]", "in" : "query", "description" : "Filter by legal_party_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sued_by_type_id]", "in" : "query", "description" : "Filter by sued_by_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[law_firm_site_id]", "in" : "query", "description" : "Filter by law_firm_site_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_name]", "in" : "query", "description" : "Filter by case_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[litigation_status_id]", "in" : "query", "description" : "Filter by litigation_status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_served]", "in" : "query", "description" : "Filter by date_served (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[date_sent_to_attorney]", "in" : "query", "description" : "Filter by date_sent_to_attorney (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[matter_number]", "in" : "query", "description" : "Filter by matter_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[court_case_number]", "in" : "query", "description" : "Filter by court_case_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_agreed_date]", "in" : "query", "description" : "Filter by damage_agreed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[insurance_claim]", "in" : "query", "description" : "Filter by insurance_claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_status]", "in" : "query", "description" : "Filter by case_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trial_date]", "in" : "query", "description" : "Filter by trial_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mediation_date]", "in" : "query", "description" : "Filter by mediation_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawFirm]", "in" : "query", "description" : "Filter by lawFirm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalParty]", "in" : "query", "description" : "Filter by legalParty (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesType]", "in" : "query", "description" : "Filter by casesType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[casesSubtype]", "in" : "query", "description" : "Filter by casesSubtype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalDamages]", "in" : "query", "description" : "Filter by legalDamages (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalRisks]", "in" : "query", "description" : "Filter by legalRisks (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalCasesFields" }, { "$ref" : "#/components/parameters/LegalCasesInclude" }, { "$ref" : "#/components/parameters/LegalCasesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalCasesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a LegalCases", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalCasesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalCasesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LegalCasesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/lawFirm" : { "get" : { "description" : "Retrieve lawFirms related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/LawFirmsFields" }, { "$ref" : "#/components/parameters/LawFirmsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LawFirmsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LawFirmsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/legalParty" : { "get" : { "description" : "Retrieve legalParties related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/LegalPartiesFields" }, { "$ref" : "#/components/parameters/LegalPartiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalPartiesResourceResponse" }, "202" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/casesType" : { "get" : { "description" : "Retrieve casesTypes related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/CasesTypesFields" }, { "$ref" : "#/components/parameters/CasesTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesTypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CasesTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/casesSubtype" : { "get" : { "description" : "Retrieve casesSubtypes related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/CasesSubtypesFields" }, { "$ref" : "#/components/parameters/CasesSubtypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesSubtypesResourceResponse" }, "202" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/legalDamages" : { "get" : { "description" : "Retrieve legalDamages related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalDamagesFields" }, { "$ref" : "#/components/parameters/LegalDamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalDamagesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/legalRisks" : { "get" : { "description" : "Retrieve legalRisks related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_risk_id]", "in" : "query", "description" : "Filter by legal_risk_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawsuit_demand_amount]", "in" : "query", "description" : "Filter by lawsuit_demand_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate]", "in" : "query", "description" : "Filter by estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_flag]", "in" : "query", "description" : "Filter by accrual_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[liability_age]", "in" : "query", "description" : "Filter by liability_age (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_reserve]", "in" : "query", "description" : "Filter by settlement_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_reserve]", "in" : "query", "description" : "Filter by expense_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_accrual_balance]", "in" : "query", "description" : "Filter by expense_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_accrual_balance]", "in" : "query", "description" : "Filter by settlement_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalRisksFields" }, { "$ref" : "#/components/parameters/LegalRisksInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalRisksResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/claimDetails" : { "get" : { "description" : "Retrieve claimDetails related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_variance_reason_id]", "in" : "query", "description" : "Filter by estimate_variance_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_accrual_balance]", "in" : "query", "description" : "Filter by retain_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_version_number]", "in" : "query", "description" : "Filter by estimate_version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_balance]", "in" : "query", "description" : "Filter by estimate_accrued_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_amount]", "in" : "query", "description" : "Filter by estimate_accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/relationships/lawFirm" : { "get" : { "description" : "Retrieve lawFirms references related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/LawFirmsFields" }, { "$ref" : "#/components/parameters/LawFirmsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LawFirmsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LawFirmsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/relationships/legalParty" : { "get" : { "description" : "Retrieve legalParties references related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/LegalPartiesFields" }, { "$ref" : "#/components/parameters/LegalPartiesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalPartiesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/LegalPartiesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/relationships/casesType" : { "get" : { "description" : "Retrieve casesTypes references related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/CasesTypesFields" }, { "$ref" : "#/components/parameters/CasesTypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesTypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CasesTypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/relationships/casesSubtype" : { "get" : { "description" : "Retrieve casesSubtypes references related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/CasesSubtypesFields" }, { "$ref" : "#/components/parameters/CasesSubtypesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/CasesSubtypesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/relationships/legalDamages" : { "get" : { "description" : "Retrieve legalDamages references related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalDamagesFields" }, { "$ref" : "#/components/parameters/LegalDamagesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalDamagesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/relationships/legalRisks" : { "get" : { "description" : "Retrieve legalRisks references related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_risk_id]", "in" : "query", "description" : "Filter by legal_risk_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lawsuit_demand_amount]", "in" : "query", "description" : "Filter by lawsuit_demand_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate]", "in" : "query", "description" : "Filter by estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_flag]", "in" : "query", "description" : "Filter by accrual_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[liability_age]", "in" : "query", "description" : "Filter by liability_age (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_reserve]", "in" : "query", "description" : "Filter by settlement_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_reserve]", "in" : "query", "description" : "Filter by expense_reserve (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expense_accrual_balance]", "in" : "query", "description" : "Filter by expense_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_accrual_balance]", "in" : "query", "description" : "Filter by settlement_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LegalRisksFields" }, { "$ref" : "#/components/parameters/LegalRisksInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LegalRisksResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/legalCases/{id}/relationships/claimDetails" : { "get" : { "description" : "Retrieve claimDetails references related to a legalCases resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LegalCasesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_id]", "in" : "query", "description" : "Filter by claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_type_id]", "in" : "query", "description" : "Filter by facility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_type_id]", "in" : "query", "description" : "Filter by utility_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[facility_id]", "in" : "query", "description" : "Filter by facility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_variance_reason_id]", "in" : "query", "description" : "Filter by estimate_variance_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_accrual_balance]", "in" : "query", "description" : "Filter by retain_accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_version_number]", "in" : "query", "description" : "Filter by estimate_version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_balance]", "in" : "query", "description" : "Filter by estimate_accrued_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_accrued_amount]", "in" : "query", "description" : "Filter by estimate_accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim]", "in" : "query", "description" : "Filter by claim (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legalCase]", "in" : "query", "description" : "Filter by legalCase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetail]", "in" : "query", "description" : "Filter by investigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimDetailsFields" }, { "$ref" : "#/components/parameters/ClaimDetailsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimDetailsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetMakes/{id}" : { "get" : { "description" : "Retrieve a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetMakesPrimaryKey" }, { "$ref" : "#/components/parameters/AssetMakesFields" }, { "$ref" : "#/components/parameters/AssetMakesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AssetMakes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetMakesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AssetMakes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetMakesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetMakes" : { "get" : { "description" : "Retrieve a List of assetMakes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributeMappings]", "in" : "query", "description" : "Filter by attributeMappings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModels]", "in" : "query", "description" : "Filter by assetModels (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[categoryTypeMakeMappings]", "in" : "query", "description" : "Filter by categoryTypeMakeMappings (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetMakesFields" }, { "$ref" : "#/components/parameters/AssetMakesInclude" }, { "$ref" : "#/components/parameters/AssetMakesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetMakesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AssetMakes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AssetMakesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetMakes/{id}/attributeMappings" : { "get" : { "description" : "Retrieve attributeMappings related to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetMakesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type_id]", "in" : "query", "description" : "Filter by asset_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetMakes/{id}/assetModels" : { "get" : { "description" : "Retrieve assetModels related to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetMakesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetModelsFields" }, { "$ref" : "#/components/parameters/AssetModelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetMakes/{id}/categoryTypeMakeMappings" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings related to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetMakesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_id]", "in" : "query", "description" : "Filter by type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_type_id]", "in" : "query", "description" : "Filter by category_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategory]", "in" : "query", "description" : "Filter by assetCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategoryType]", "in" : "query", "description" : "Filter by assetCategoryType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetMakes/{id}/relationships/attributeMappings" : { "get" : { "description" : "Retrieve attributeMappings references related to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetMakesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute_id]", "in" : "query", "description" : "Filter by attribute_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type_id]", "in" : "query", "description" : "Filter by asset_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_id]", "in" : "query", "description" : "Filter by model_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAttribute]", "in" : "query", "description" : "Filter by assetAttribute (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetModel]", "in" : "query", "description" : "Filter by assetModel (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCode]", "in" : "query", "description" : "Filter by quickCode (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttributeMappingsFields" }, { "$ref" : "#/components/parameters/AttributeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AttributeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetMakes/{id}/relationships/assetModels" : { "get" : { "description" : "Retrieve assetModels references related to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetMakesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetModelsFields" }, { "$ref" : "#/components/parameters/AssetModelsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetModelsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/assetMakes/{id}/relationships/categoryTypeMakeMappings" : { "get" : { "description" : "Retrieve categoryTypeMakeMappings references related to a assetMakes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AssetMakesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_id]", "in" : "query", "description" : "Filter by category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_id]", "in" : "query", "description" : "Filter by type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make_id]", "in" : "query", "description" : "Filter by make_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[category_type_id]", "in" : "query", "description" : "Filter by category_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategory]", "in" : "query", "description" : "Filter by assetCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetType]", "in" : "query", "description" : "Filter by assetType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetMake]", "in" : "query", "description" : "Filter by assetMake (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetCategoryType]", "in" : "query", "description" : "Filter by assetCategoryType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assets]", "in" : "query", "description" : "Filter by assets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsFields" }, { "$ref" : "#/components/parameters/CategoryTypeMakeMappingsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/CategoryTypeMakeMappingsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/loanedEmployeeAssets/{id}" : { "get" : { "description" : "Retrieve a loanedEmployeeAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsFields" }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LoanedEmployeeAssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/LoanedEmployeeAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a LoanedEmployeeAssets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/LoanedEmployeeAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a LoanedEmployeeAssets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LoanedEmployeeAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/loanedEmployeeAssets" : { "get" : { "description" : "Retrieve a List of loanedEmployeeAssets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_name]", "in" : "query", "description" : "Filter by employee_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_title]", "in" : "query", "description" : "Filter by job_title (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[home_supgroup]", "in" : "query", "description" : "Filter by home_supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[home_district]", "in" : "query", "description" : "Filter by home_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[home_district_id]", "in" : "query", "description" : "Filter by home_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loan_supgroup]", "in" : "query", "description" : "Filter by loan_supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loan_district]", "in" : "query", "description" : "Filter by loan_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[loan_district_id]", "in" : "query", "description" : "Filter by loan_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_description]", "in" : "query", "description" : "Filter by asset_description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_type]", "in" : "query", "description" : "Filter by asset_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[serial_number]", "in" : "query", "description" : "Filter by serial_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tag_number]", "in" : "query", "description" : "Filter by tag_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_supgroup]", "in" : "query", "description" : "Filter by asset_supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_district]", "in" : "query", "description" : "Filter by asset_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_district_id]", "in" : "query", "description" : "Filter by asset_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_place]", "in" : "query", "description" : "Filter by asset_place (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsFields" }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsInclude" }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LoanedEmployeeAssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LoanedEmployeeAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a LoanedEmployeeAssets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/LoanedEmployeeAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/loanedEmployeeAssets/{id}/asset" : { "get" : { "description" : "Retrieve assets related to a loanedEmployeeAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/assetmanager/1.0/loanedEmployeeAssets/{id}/relationships/asset" : { "get" : { "description" : "Retrieve assets references related to a loanedEmployeeAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/LoanedEmployeeAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/AssetsFields" }, { "$ref" : "#/components/parameters/AssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/AssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/payeeAddresses/{id}" : { "get" : { "description" : "Retrieve a payeeAddresses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PayeeAddressesPrimaryKey" }, { "$ref" : "#/components/parameters/PayeeAddressesFields" }, { "$ref" : "#/components/parameters/PayeeAddressesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PayeeAddressesResourceResponse" }, "202" : { "$ref" : "#/components/responses/PayeeAddressesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a PayeeAddresses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PayeeAddressesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/PayeeAddressesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a PayeeAddresses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PayeeAddressesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PayeeAddressesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PayeeAddressesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/payeeAddresses" : { "get" : { "description" : "Retrieve a List of payeeAddresses resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payee]", "in" : "query", "description" : "Filter by payee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[address]", "in" : "query", "description" : "Filter by address (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[workday_vendor_number]", "in" : "query", "description" : "Filter by workday_vendor_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claims]", "in" : "query", "description" : "Filter by claims (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/PayeeAddressesFields" }, { "$ref" : "#/components/parameters/PayeeAddressesInclude" }, { "$ref" : "#/components/parameters/PayeeAddressesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/PayeeAddressesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/PayeeAddressesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a PayeeAddresses", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PayeeAddressesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PayeeAddressesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/PayeeAddressesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/payeeAddresses/{id}/claims" : { "get" : { "description" : "Retrieve claims related to a payeeAddresses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PayeeAddressesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/payeeAddresses/{id}/relationships/claims" : { "get" : { "description" : "Retrieve claims references related to a payeeAddresses resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/PayeeAddressesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_id]", "in" : "query", "description" : "Filter by customer_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_category_id]", "in" : "query", "description" : "Filter by claim_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_number]", "in" : "query", "description" : "Filter by invoice_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_date]", "in" : "query", "description" : "Filter by invoice_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_receipt_date]", "in" : "query", "description" : "Filter by invoice_receipt_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_request_date]", "in" : "query", "description" : "Filter by payment_request_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[invoice_amount]", "in" : "query", "description" : "Filter by invoice_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_amount]", "in" : "query", "description" : "Filter by payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cost_center_id]", "in" : "query", "description" : "Filter by cost_center_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_amount]", "in" : "query", "description" : "Filter by accrued_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued_period_id]", "in" : "query", "description" : "Filter by accrued_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payment_mode_id]", "in" : "query", "description" : "Filter by payment_mode_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[disputed]", "in" : "query", "description" : "Filter by disputed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[spend_category_id]", "in" : "query", "description" : "Filter by spend_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[final_disposition_id]", "in" : "query", "description" : "Filter by final_disposition_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status_id]", "in" : "query", "description" : "Filter by status_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_by]", "in" : "query", "description" : "Filter by approved_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_int]", "in" : "query", "description" : "Filter by att1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_int]", "in" : "query", "description" : "Filter by att2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_int]", "in" : "query", "description" : "Filter by att3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att1_var]", "in" : "query", "description" : "Filter by att1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att2_var]", "in" : "query", "description" : "Filter by att2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[att3_var]", "in" : "query", "description" : "Filter by att3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_id]", "in" : "query", "description" : "Filter by claim_payee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claim_payee_address_id]", "in" : "query", "description" : "Filter by claim_payee_address_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reviewed_by]", "in" : "query", "description" : "Filter by reviewed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[review_date]", "in" : "query", "description" : "Filter by review_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[paid]", "in" : "query", "description" : "Filter by paid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[case_id]", "in" : "query", "description" : "Filter by case_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[docket_number]", "in" : "query", "description" : "Filter by docket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[retain_reserve_balance]", "in" : "query", "description" : "Filter by retain_reserve_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[settlement_pay_amount]", "in" : "query", "description" : "Filter by settlement_pay_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_estimate]", "in" : "query", "description" : "Filter by should_cost_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wd_supplier_invoice_reference]", "in" : "query", "description" : "Filter by wd_supplier_invoice_reference (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[should_cost_variance_id]", "in" : "query", "description" : "Filter by should_cost_variance_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[original_claim_id]", "in" : "query", "description" : "Filter by original_claim_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer]", "in" : "query", "description" : "Filter by customer (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimCategory]", "in" : "query", "description" : "Filter by claimCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[payeeAddress]", "in" : "query", "description" : "Filter by payeeAddress (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimSpendCategory]", "in" : "query", "description" : "Filter by claimSpendCategory (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDetails]", "in" : "query", "description" : "Filter by claimDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[claimDiscounts]", "in" : "query", "description" : "Filter by claimDiscounts (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ClaimsFields" }, { "$ref" : "#/components/parameters/ClaimsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ClaimsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/ticketsInfo/{id}" : { "get" : { "description" : "Retrieve a ticketsInfo resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsInfoPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsInfoFields" }, { "$ref" : "#/components/parameters/TicketsInfoInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsInfoResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsInfoResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a TicketsInfo", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsInfoPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TicketsInfoResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a TicketsInfo", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsInfoPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsInfoPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TicketsInfoResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/ticketsInfo" : { "get" : { "description" : "Retrieve a List of ticketsInfo resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[expires_date]", "in" : "query", "description" : "Filter by expires_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet]", "in" : "query", "description" : "Filter by meet (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lot_type]", "in" : "query", "description" : "Filter by lot_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lot_ownership]", "in" : "query", "description" : "Filter by lot_ownership (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_time_type]", "in" : "query", "description" : "Filter by work_time_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_date]", "in" : "query", "description" : "Filter by meet_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[area_id]", "in" : "query", "description" : "Filter by area_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_contractor]", "in" : "query", "description" : "Filter by master_contractor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eta]", "in" : "query", "description" : "Filter by eta (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_cn_reviewed]", "in" : "query", "description" : "Filter by sup_cn_reviewed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_cn_reviewed]", "in" : "query", "description" : "Filter by rms_cn_reviewed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_cn_map_sent]", "in" : "query", "description" : "Filter by rms_cn_map_sent (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_cn_deferred]", "in" : "query", "description" : "Filter by rms_cn_deferred (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[rms_eet_assigned]", "in" : "query", "description" : "Filter by rms_eet_assigned (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsInfoFields" }, { "$ref" : "#/components/parameters/TicketsInfoInclude" }, { "$ref" : "#/components/parameters/TicketsInfoSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsInfoResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsInfoResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a TicketsInfo", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsInfoPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsInfoResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TicketsInfoResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/ticketsInfo/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a ticketsInfo resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsInfoPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/ticketsInfo/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a ticketsInfo resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TicketsInfoPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reports/{id}" : { "get" : { "description" : "Retrieve a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" }, { "$ref" : "#/components/parameters/ReportsFields" }, { "$ref" : "#/components/parameters/ReportsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a Reports", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Reports", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reports" : { "get" : { "description" : "Retrieve a List of reports resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_source_id]", "in" : "query", "description" : "Filter by report_source_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_type]", "in" : "query", "description" : "Filter by report_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model]", "in" : "query", "description" : "Filter by model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sql]", "in" : "query", "description" : "Filter by sql (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[params]", "in" : "query", "description" : "Filter by params (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[columns]", "in" : "query", "description" : "Filter by columns (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportSource]", "in" : "query", "description" : "Filter by reportSource (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportsFields" }, { "$ref" : "#/components/parameters/ReportsInclude" }, { "$ref" : "#/components/parameters/ReportsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a Reports", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reports/{id}/reportSource" : { "get" : { "description" : "Retrieve reportSources related to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" }, { "$ref" : "#/components/parameters/ReportSourcesFields" }, { "$ref" : "#/components/parameters/ReportSourcesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reports relationship to a reportSources resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reports relationship to a reportSources resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reports relationship to a reportSources resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reports/{id}/relationships/reportSource" : { "get" : { "description" : "Retrieve reportSources references related to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" }, { "$ref" : "#/components/parameters/ReportSourcesFields" }, { "$ref" : "#/components/parameters/ReportSourcesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reports relationship to a reportSources resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reports relationship to a reportSources resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reports relationship to a reportSources resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportSources/{id}" : { "get" : { "description" : "Retrieve a reportSources resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" }, { "$ref" : "#/components/parameters/ReportSourcesFields" }, { "$ref" : "#/components/parameters/ReportSourcesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourceResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a ReportSources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a ReportSources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportSources" : { "get" : { "description" : "Retrieve a List of reportSources resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[data_source]", "in" : "query", "description" : "Filter by data_source (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reports]", "in" : "query", "description" : "Filter by reports (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportSourcesFields" }, { "$ref" : "#/components/parameters/ReportSourcesInclude" }, { "$ref" : "#/components/parameters/ReportSourcesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportSourcesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a ReportSources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/ReportSourcesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportSources/{id}/reports" : { "get" : { "description" : "Retrieve reports related to a reportSources resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_source_id]", "in" : "query", "description" : "Filter by report_source_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_type]", "in" : "query", "description" : "Filter by report_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model]", "in" : "query", "description" : "Filter by model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sql]", "in" : "query", "description" : "Filter by sql (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[params]", "in" : "query", "description" : "Filter by params (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[columns]", "in" : "query", "description" : "Filter by columns (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportSource]", "in" : "query", "description" : "Filter by reportSource (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportsFields" }, { "$ref" : "#/components/parameters/ReportsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportSources relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportSources relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportSources relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/reportSources/{id}/relationships/reports" : { "get" : { "description" : "Retrieve reports references related to a reportSources resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_source_id]", "in" : "query", "description" : "Filter by report_source_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[report_type]", "in" : "query", "description" : "Filter by report_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model]", "in" : "query", "description" : "Filter by model (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sql]", "in" : "query", "description" : "Filter by sql (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[params]", "in" : "query", "description" : "Filter by params (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[columns]", "in" : "query", "description" : "Filter by columns (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[required_roles]", "in" : "query", "description" : "Filter by required_roles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[reportSource]", "in" : "query", "description" : "Filter by reportSource (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/ReportsFields" }, { "$ref" : "#/components/parameters/ReportsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create reportSources relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete reportSources relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update reportSources relationship to a reports resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/ReportSourcesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/ReportsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions/{id}" : { "get" : { "description" : "Retrieve a transmissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "delete" : { "description" : "Delete a Transmissions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a Transmissions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions" : { "get" : { "description" : "Retrieve a List of transmissions resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_type]", "in" : "query", "description" : "Filter by message_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[trans_number]", "in" : "query", "description" : "Filter by trans_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[call_date]", "in" : "query", "description" : "Filter by call_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[parse_date]", "in" : "query", "description" : "Filter by parse_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emergency]", "in" : "query", "description" : "Filter by emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[short_notice]", "in" : "query", "description" : "Filter by short_notice (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[after_hours]", "in" : "query", "description" : "Filter by after_hours (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed_id]", "in" : "query", "description" : "Filter by feed_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet]", "in" : "query", "description" : "Filter by meet (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_date]", "in" : "query", "description" : "Filter by meet_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[meet_code]", "in" : "query", "description" : "Filter by meet_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmitted_legal_due_date]", "in" : "query", "description" : "Filter by transmitted_legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_type]", "in" : "query", "description" : "Filter by transmission_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[service_area_code]", "in" : "query", "description" : "Filter by service_area_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[master_code]", "in" : "query", "description" : "Filter by master_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billing_code]", "in" : "query", "description" : "Filter by billing_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[download_time]", "in" : "query", "description" : "Filter by download_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subdivision]", "in" : "query", "description" : "Filter by subdivision (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_dir]", "in" : "query", "description" : "Filter by street_dir (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[typeofwork]", "in" : "query", "description" : "Filter by typeofwork (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lead_time]", "in" : "query", "description" : "Filter by lead_time (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[raw_image]", "in" : "query", "description" : "Filter by raw_image (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sourcefilename]", "in" : "query", "description" : "Filter by sourcefilename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_name]", "in" : "query", "description" : "Filter by caller_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_phone]", "in" : "query", "description" : "Filter by caller_phone (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_fax]", "in" : "query", "description" : "Filter by caller_fax (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[caller_email]", "in" : "query", "description" : "Filter by caller_email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_address_1]", "in" : "query", "description" : "Filter by excavator_address_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_city]", "in" : "query", "description" : "Filter by excavator_city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_done_for]", "in" : "query", "description" : "Filter by work_done_for (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[maplocation]", "in" : "query", "description" : "Filter by maplocation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[mapbook]", "in" : "query", "description" : "Filter by mapbook (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[description]", "in" : "query", "description" : "Filter by description (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[blasting]", "in" : "query", "description" : "Filter by blasting (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street1]", "in" : "query", "description" : "Filter by cross_street1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_street2]", "in" : "query", "description" : "Filter by cross_street2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[usic_ticket_type]", "in" : "query", "description" : "Filter by usic_ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickets]", "in" : "query", "description" : "Filter by tickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[feed]", "in" : "query", "description" : "Filter by feed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TransmissionsFields" }, { "$ref" : "#/components/parameters/TransmissionsInclude" }, { "$ref" : "#/components/parameters/TransmissionsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TransmissionsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } }, "tags" : [ "unauthorized" ] }, "post" : { "description" : "Create a Transmissions", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/TransmissionsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions/{id}/locates" : { "get" : { "description" : "Retrieve locates related to a transmissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions/{id}/tickets" : { "get" : { "description" : "Retrieve tickets related to a transmissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticketsInfo]", "in" : "query", "description" : "Filter by ticketsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachments]", "in" : "query", "description" : "Filter by tkpAttachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentsCategorized]", "in" : "query", "description" : "Filter by attachmentsCategorized (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachmentsWithNotifications]", "in" : "query", "description" : "Filter by tkpAttachmentsWithNotifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkedTickets]", "in" : "query", "description" : "Filter by linkedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions/{id}/cpClosedTickets" : { "get" : { "description" : "Retrieve ticketCloseds related to a transmissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketClosedsFields" }, { "$ref" : "#/components/parameters/TicketClosedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketClosedsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions/{id}/feed" : { "get" : { "description" : "Retrieve feeds related to a transmissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourceResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions/{id}/relationships/locates" : { "get" : { "description" : "Retrieve locates references related to a transmissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[seqnum]", "in" : "query", "description" : "Filter by seqnum (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[initial_status_date]", "in" : "query", "description" : "Filter by initial_status_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[client_id]", "in" : "query", "description" : "Filter by client_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket_id]", "in" : "query", "description" : "Filter by bucket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile_id]", "in" : "query", "description" : "Filter by high_profile_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[added_by_id]", "in" : "query", "description" : "Filter by added_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_activity_id]", "in" : "query", "description" : "Filter by latest_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_due_date]", "in" : "query", "description" : "Filter by legal_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility_id]", "in" : "query", "description" : "Filter by utility_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[first_closing_activity_id]", "in" : "query", "description" : "Filter by first_closing_activity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[past_due]", "in" : "query", "description" : "Filter by past_due (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bucket]", "in" : "query", "description" : "Filter by bucket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionExtra]", "in" : "query", "description" : "Filter by transmissionExtra (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionText]", "in" : "query", "description" : "Filter by transmissionText (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latestActivity]", "in" : "query", "description" : "Filter by latestActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[firstClosingActivity]", "in" : "query", "description" : "Filter by firstClosingActivity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[term]", "in" : "query", "description" : "Filter by term (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[termUtilityMap]", "in" : "query", "description" : "Filter by termUtilityMap (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activities]", "in" : "query", "description" : "Filter by activities (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/LocatesFields" }, { "$ref" : "#/components/parameters/LocatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/LocatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions/{id}/relationships/tickets" : { "get" : { "description" : "Retrieve tickets references related to a transmissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open]", "in" : "query", "description" : "Filter by open (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locate_list_cache]", "in" : "query", "description" : "Filter by locate_list_cache (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latest_transmission_id]", "in" : "query", "description" : "Filter by latest_transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[open_emergency]", "in" : "query", "description" : "Filter by open_emergency (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_contact_id]", "in" : "query", "description" : "Filter by ticket_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_contact_id]", "in" : "query", "description" : "Filter by excavator_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ordered_by_contact_id]", "in" : "query", "description" : "Filter by ordered_by_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[bill_to_contact_id]", "in" : "query", "description" : "Filter by bill_to_contact_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_invoice_signature_id]", "in" : "query", "description" : "Filter by ticket_invoice_signature_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[billed_manually]", "in" : "query", "description" : "Filter by billed_manually (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[risk_score]", "in" : "query", "description" : "Filter by risk_score (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_district_id]", "in" : "query", "description" : "Filter by ticket_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_sup_group_id]", "in" : "query", "description" : "Filter by ticket_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locates]", "in" : "query", "description" : "Filter by locates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[visits]", "in" : "query", "description" : "Filter by visits (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticketsInfo]", "in" : "query", "description" : "Filter by ticketsInfo (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dueDateExtensions]", "in" : "query", "description" : "Filter by dueDateExtensions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionDetail]", "in" : "query", "description" : "Filter by transmissionDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpDistrict]", "in" : "query", "description" : "Filter by tkpDistrict (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cpClosedTickets]", "in" : "query", "description" : "Filter by cpClosedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachments]", "in" : "query", "description" : "Filter by tkpAttachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentsCategorized]", "in" : "query", "description" : "Filter by attachmentsCategorized (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[projectTicket]", "in" : "query", "description" : "Filter by projectTicket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tkpAttachmentsWithNotifications]", "in" : "query", "description" : "Filter by tkpAttachmentsWithNotifications (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[activityPathPoints]", "in" : "query", "description" : "Filter by activityPathPoints (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[linkedTickets]", "in" : "query", "description" : "Filter by linkedTickets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions/{id}/relationships/cpClosedTickets" : { "get" : { "description" : "Retrieve ticketCloseds references related to a transmissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[tickettype]", "in" : "query", "description" : "Filter by tickettype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[work_date]", "in" : "query", "description" : "Filter by work_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmit_date]", "in" : "query", "description" : "Filter by transmit_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[our_due_date]", "in" : "query", "description" : "Filter by our_due_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[closed_date]", "in" : "query", "description" : "Filter by closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[street_number]", "in" : "query", "description" : "Filter by street_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[streetname]", "in" : "query", "description" : "Filter by streetname (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator]", "in" : "query", "description" : "Filter by locator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[utility]", "in" : "query", "description" : "Filter by utility (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission_id]", "in" : "query", "description" : "Filter by transmission_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[contract_number]", "in" : "query", "description" : "Filter by contract_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[project]", "in" : "query", "description" : "Filter by project (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[high_profile]", "in" : "query", "description" : "Filter by high_profile (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmissionBase]", "in" : "query", "description" : "Filter by transmissionBase (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[transmission]", "in" : "query", "description" : "Filter by transmission (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/TicketClosedsFields" }, { "$ref" : "#/components/parameters/TicketClosedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/TicketClosedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/transmissions/{id}/relationships/feed" : { "get" : { "description" : "Retrieve feeds references related to a transmissions resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/TransmissionsPrimaryKey" }, { "$ref" : "#/components/parameters/FeedsFields" }, { "$ref" : "#/components/parameters/FeedsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/FeedsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/FeedsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets/{id}" : { "get" : { "description" : "Retrieve a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a EmployeesActiveNoAssets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a EmployeesActiveNoAssets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets" : { "get" : { "description" : "Retrieve a List of employeesActiveNoAssets resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_id]", "in" : "query", "description" : "Filter by emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[emp_type]", "in" : "query", "description" : "Filter by emp_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name]", "in" : "query", "description" : "Filter by legal_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_last]", "in" : "query", "description" : "Filter by legal_name_last (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[legal_name_first]", "in" : "query", "description" : "Filter by legal_name_first (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[job_code]", "in" : "query", "description" : "Filter by job_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[position]", "in" : "query", "description" : "Filter by position (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[email]", "in" : "query", "description" : "Filter by email (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active_status]", "in" : "query", "description" : "Filter by active_status (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_date]", "in" : "query", "description" : "Filter by effective_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_id]", "in" : "query", "description" : "Filter by sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_group_code]", "in" : "query", "description" : "Filter by sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sup_emp_id]", "in" : "query", "description" : "Filter by sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supervisor]", "in" : "query", "description" : "Filter by supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_abbr]", "in" : "query", "description" : "Filter by district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[state]", "in" : "query", "description" : "Filter by state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[region]", "in" : "query", "description" : "Filter by region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_id]", "in" : "query", "description" : "Filter by eff_sup_group_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_group_code]", "in" : "query", "description" : "Filter by eff_sup_group_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_sup_emp_id]", "in" : "query", "description" : "Filter by eff_sup_emp_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_supervisor]", "in" : "query", "description" : "Filter by eff_supervisor (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_id]", "in" : "query", "description" : "Filter by eff_district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district]", "in" : "query", "description" : "Filter by eff_district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_district_abbr]", "in" : "query", "description" : "Filter by eff_district_abbr (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_state]", "in" : "query", "description" : "Filter by eff_state (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[eff_region]", "in" : "query", "description" : "Filter by eff_region (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[exclusion_code]", "in" : "query", "description" : "Filter by exclusion_code (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dist]", "in" : "query", "description" : "Filter by dist (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[supgroup]", "in" : "query", "description" : "Filter by supgroup (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vehicles]", "in" : "query", "description" : "Filter by vehicles (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assetAssignments]", "in" : "query", "description" : "Filter by assetAssignments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsFields" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsInclude" }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a EmployeesActiveNoAssets", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/EmployeesActiveNoAssetsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets/{id}/dist" : { "get" : { "description" : "Retrieve districts related to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets/{id}/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups related to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets/{id}/vehicles" : { "get" : { "description" : "Retrieve vehicles related to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cvn]", "in" : "query", "description" : "Filter by cvn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_year]", "in" : "query", "description" : "Filter by model_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make]", "in" : "query", "description" : "Filter by make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_group]", "in" : "query", "description" : "Filter by model_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vin_number]", "in" : "query", "description" : "Filter by vin_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[license_plate_number]", "in" : "query", "description" : "Filter by license_plate_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets/{id}/assetAssignments" : { "get" : { "description" : "Retrieve assetAssignments related to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets/{id}/relationships/dist" : { "get" : { "description" : "Retrieve districts references related to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/DistrictsFields" }, { "$ref" : "#/components/parameters/DistrictsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/DistrictsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/DistrictsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets/{id}/relationships/supgroup" : { "get" : { "description" : "Retrieve supervisorGroups references related to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/SupervisorGroupsFields" }, { "$ref" : "#/components/parameters/SupervisorGroupsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/SupervisorGroupsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets/{id}/relationships/vehicles" : { "get" : { "description" : "Retrieve vehicles references related to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[cvn]", "in" : "query", "description" : "Filter by cvn (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_year]", "in" : "query", "description" : "Filter by model_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[make]", "in" : "query", "description" : "Filter by make (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[model_group]", "in" : "query", "description" : "Filter by model_group (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[vin_number]", "in" : "query", "description" : "Filter by vin_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[book_value]", "in" : "query", "description" : "Filter by book_value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[license_plate_number]", "in" : "query", "description" : "Filter by license_plate_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/VehiclesFields" }, { "$ref" : "#/components/parameters/VehiclesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/VehiclesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/employeesActiveNoAssets/{id}/relationships/assetAssignments" : { "get" : { "description" : "Retrieve assetAssignments references related to a employeesActiveNoAssets resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/EmployeesActiveNoAssetsPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset_id]", "in" : "query", "description" : "Filter by asset_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_by]", "in" : "query", "description" : "Filter by assigned_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assigned_on]", "in" : "query", "description" : "Filter by assigned_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[notes]", "in" : "query", "description" : "Filter by notes (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[primary_flag]", "in" : "query", "description" : "Filter by primary_flag (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveNoAsset]", "in" : "query", "description" : "Filter by employeesActiveNoAsset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeesActiveMultipleItAssets]", "in" : "query", "description" : "Filter by employeesActiveMultipleItAssets (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[assignedByEmployee]", "in" : "query", "description" : "Filter by assignedByEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employeeOnLoan]", "in" : "query", "description" : "Filter by employeeOnLoan (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[asset]", "in" : "query", "description" : "Filter by asset (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AssetAssignmentsFields" }, { "$ref" : "#/components/parameters/AssetAssignmentsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AssetAssignmentsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messagesWithCounts/{id}" : { "get" : { "description" : "Retrieve a messagesWithCounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesWithCountsPrimaryKey" }, { "$ref" : "#/components/parameters/MessagesWithCountsFields" }, { "$ref" : "#/components/parameters/MessagesWithCountsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesWithCountsResourceResponse" }, "202" : { "$ref" : "#/components/responses/MessagesWithCountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a MessagesWithCounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesWithCountsPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/MessagesWithCountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a MessagesWithCounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesWithCountsPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesWithCountsPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/MessagesWithCountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messagesWithCounts" : { "get" : { "description" : "Retrieve a List of messagesWithCounts resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message]", "in" : "query", "description" : "Filter by message (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_start_date]", "in" : "query", "description" : "Filter by effective_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[effective_end_date]", "in" : "query", "description" : "Filter by effective_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute4]", "in" : "query", "description" : "Filter by attribute4 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute5]", "in" : "query", "description" : "Filter by attribute5 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee_id]", "in" : "query", "description" : "Filter by employee_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[subject]", "in" : "query", "description" : "Filter by subject (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[message_preview]", "in" : "query", "description" : "Filter by message_preview (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[require_acknowledgement]", "in" : "query", "description" : "Filter by require_acknowledgement (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[unreadCount]", "in" : "query", "description" : "Filter by unreadCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[readCount]", "in" : "query", "description" : "Filter by readCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[sentCount]", "in" : "query", "description" : "Filter by sentCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[acknowledgedCount]", "in" : "query", "description" : "Filter by acknowledgedCount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/MessagesWithCountsFields" }, { "$ref" : "#/components/parameters/MessagesWithCountsInclude" }, { "$ref" : "#/components/parameters/MessagesWithCountsSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/MessagesWithCountsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/MessagesWithCountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a MessagesWithCounts", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesWithCountsPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/MessagesWithCountsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messagesWithCounts/{id}/employee" : { "get" : { "description" : "Retrieve employees related to a messagesWithCounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesWithCountsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/messaging/1.0/messagesWithCounts/{id}/relationships/employee" : { "get" : { "description" : "Retrieve employees references related to a messagesWithCounts resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/MessagesWithCountsPrimaryKey" }, { "$ref" : "#/components/parameters/EmployeesFields" }, { "$ref" : "#/components/parameters/EmployeesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EmployeesResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/EmployeesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodeValues/{id}" : { "get" : { "description" : "Retrieve a quickCodeValue resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuePrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a QuickCodeValue", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuePrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a QuickCodeValue", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuePrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValuePatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodeValues" : { "get" : { "description" : "Retrieve a List of quickCodeValue resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quick_code_id]", "in" : "query", "description" : "Filter by quick_code_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[value]", "in" : "query", "description" : "Filter by value (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[display_name]", "in" : "query", "description" : "Filter by display_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[start_date]", "in" : "query", "description" : "Filter by start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[end_date]", "in" : "query", "description" : "Filter by end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickC]", "in" : "query", "description" : "Filter by quickC (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigations]", "in" : "query", "description" : "Filter by investigations (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/QuickCodeValueFields" }, { "$ref" : "#/components/parameters/QuickCodeValueInclude" }, { "$ref" : "#/components/parameters/QuickCodeValueSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeValueResourcesResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a QuickCodeValue", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValuePostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValueResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/QuickCodeValueResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodeValues/{id}/quickC" : { "get" : { "description" : "Retrieve quickCode related to a quickCodeValue resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuePrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeFields" }, { "$ref" : "#/components/parameters/QuickCodeInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeResourceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodeValues/{id}/estimates" : { "get" : { "description" : "Retrieve estimates related to a quickCodeValue resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodeValues/{id}/investigations" : { "get" : { "description" : "Retrieve investigations related to a quickCodeValue resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavationType]", "in" : "query", "description" : "Filter by excavationType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavat]", "in" : "query", "description" : "Filter by excavat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetails]", "in" : "query", "description" : "Filter by investigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersions]", "in" : "query", "description" : "Filter by investigationVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetails]", "in" : "query", "description" : "Filter by cmsInvestigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenEmployee]", "in" : "query", "description" : "Filter by picsTakenEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireAnswers]", "in" : "query", "description" : "Filter by questionnaireAnswers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourcesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodeValues/{id}/relationships/quickC" : { "get" : { "description" : "Retrieve quickCode references related to a quickCodeValue resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuePrimaryKey" }, { "$ref" : "#/components/parameters/QuickCodeFields" }, { "$ref" : "#/components/parameters/QuickCodeInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/QuickCodeResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/QuickCodeResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodeValues/{id}/relationships/estimates" : { "get" : { "description" : "Retrieve estimates references related to a quickCodeValue resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_id]", "in" : "query", "description" : "Filter by estimate_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[version_number]", "in" : "query", "description" : "Filter by version_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_id]", "in" : "query", "description" : "Filter by investigation_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation_detail_id]", "in" : "query", "description" : "Filter by investigation_detail_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_notification_id]", "in" : "query", "description" : "Filter by wf_notification_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_category_id]", "in" : "query", "description" : "Filter by estimate_category_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[period_id]", "in" : "query", "description" : "Filter by period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[request_id]", "in" : "query", "description" : "Filter by request_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_reason_id]", "in" : "query", "description" : "Filter by dispute_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dispute_estimate]", "in" : "query", "description" : "Filter by dispute_estimate (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrued]", "in" : "query", "description" : "Filter by accrued (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[count_against_quality_ratio]", "in" : "query", "description" : "Filter by count_against_quality_ratio (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[third_party_name]", "in" : "query", "description" : "Filter by third_party_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[amount]", "in" : "query", "description" : "Filter by amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[default_amount]", "in" : "query", "description" : "Filter by default_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[adjusted_amount]", "in" : "query", "description" : "Filter by adjusted_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_amount]", "in" : "query", "description" : "Filter by accrual_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[difference_reason_id]", "in" : "query", "description" : "Filter by difference_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimate_date]", "in" : "query", "description" : "Filter by estimate_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason]", "in" : "query", "description" : "Filter by change_reason (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_by]", "in" : "query", "description" : "Filter by completed_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_period_id]", "in" : "query", "description" : "Filter by policy_drop_off_period_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off]", "in" : "query", "description" : "Filter by policy_drop_off (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_month]", "in" : "query", "description" : "Filter by policy_drop_off_month (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_year]", "in" : "query", "description" : "Filter by policy_drop_off_year (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policy_drop_off_amount]", "in" : "query", "description" : "Filter by policy_drop_off_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[prorated_payment_amount]", "in" : "query", "description" : "Filter by prorated_payment_amount (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes1]", "in" : "query", "description" : "Filter by attributes1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes2]", "in" : "query", "description" : "Filter by attributes2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attributes3]", "in" : "query", "description" : "Filter by attributes3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[accrual_balance]", "in" : "query", "description" : "Filter by accrual_balance (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetail]", "in" : "query", "description" : "Filter by cmsInvestigationDetail (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigation]", "in" : "query", "description" : "Filter by investigation (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district]", "in" : "query", "description" : "Filter by district (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[financialPeriod]", "in" : "query", "description" : "Filter by financialPeriod (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[quickCValue]", "in" : "query", "description" : "Filter by quickCValue (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsRequest]", "in" : "query", "description" : "Filter by cmsRequest (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/EstimatesFields" }, { "$ref" : "#/components/parameters/EstimatesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/EstimatesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/cms/1.0/quickCodeValues/{id}/relationships/investigations" : { "get" : { "description" : "Retrieve investigations references related to a quickCodeValue resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/QuickCodeValuePrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage_id]", "in" : "query", "description" : "Filter by damage_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator_id]", "in" : "query", "description" : "Filter by excavator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavation_type_id]", "in" : "query", "description" : "Filter by excavation_type_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_number]", "in" : "query", "description" : "Filter by ticket_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_start_date]", "in" : "query", "description" : "Filter by ticket_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_closed_date]", "in" : "query", "description" : "Filter by ticket_closed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_start_date]", "in" : "query", "description" : "Filter by inv_start_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[inv_end_date]", "in" : "query", "description" : "Filter by inv_end_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_req]", "in" : "query", "description" : "Filter by dig_up_dmg_req (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dig_up_dmg_ticket]", "in" : "query", "description" : "Filter by dig_up_dmg_ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pics_taken_by]", "in" : "query", "description" : "Filter by pics_taken_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved]", "in" : "query", "description" : "Filter by approved (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approved_date]", "in" : "query", "description" : "Filter by approved_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[approver]", "in" : "query", "description" : "Filter by approver (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[district_id]", "in" : "query", "description" : "Filter by district_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_1]", "in" : "query", "description" : "Filter by add_1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[add_2]", "in" : "query", "description" : "Filter by add_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[city]", "in" : "query", "description" : "Filter by city (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[stateid]", "in" : "query", "description" : "Filter by stateid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[zip]", "in" : "query", "description" : "Filter by zip (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[county]", "in" : "query", "description" : "Filter by county (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[countryid]", "in" : "query", "description" : "Filter by countryid (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str1]", "in" : "query", "description" : "Filter by cross_str1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cross_str2]", "in" : "query", "description" : "Filter by cross_str2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavator]", "in" : "query", "description" : "Filter by excavator (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_id]", "in" : "query", "description" : "Filter by locator_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_first_nm]", "in" : "query", "description" : "Filter by locator_first_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[locator_last_nm]", "in" : "query", "description" : "Filter by locator_last_nm (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_type]", "in" : "query", "description" : "Filter by ticket_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[type_of_work]", "in" : "query", "description" : "Filter by type_of_work (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[boring]", "in" : "query", "description" : "Filter by boring (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed]", "in" : "query", "description" : "Filter by completed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[owner]", "in" : "query", "description" : "Filter by owner (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[completed_date]", "in" : "query", "description" : "Filter by completed_date (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[wf_item_id]", "in" : "query", "description" : "Filter by wf_item_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[search_text]", "in" : "query", "description" : "Filter by search_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[latitude]", "in" : "query", "description" : "Filter by latitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[longitude]", "in" : "query", "description" : "Filter by longitude (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[geo_location]", "in" : "query", "description" : "Filter by geo_location (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[dots_number]", "in" : "query", "description" : "Filter by dots_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number]", "in" : "query", "description" : "Filter by customer_claim_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_claim_number_2]", "in" : "query", "description" : "Filter by customer_claim_number_2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[post_approver_change]", "in" : "query", "description" : "Filter by post_approver_change (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_id]", "in" : "query", "description" : "Filter by change_reason_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[change_reason_text]", "in" : "query", "description" : "Filter by change_reason_text (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[one_call_request_ticket_id]", "in" : "query", "description" : "Filter by one_call_request_ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[damage]", "in" : "query", "description" : "Filter by damage (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavationType]", "in" : "query", "description" : "Filter by excavationType (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[excavat]", "in" : "query", "description" : "Filter by excavat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetails]", "in" : "query", "description" : "Filter by investigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationDetailsVersions]", "in" : "query", "description" : "Filter by investigationDetailsVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[investigationVersions]", "in" : "query", "description" : "Filter by investigationVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[cmsInvestigationDetails]", "in" : "query", "description" : "Filter by cmsInvestigationDetails (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[employee]", "in" : "query", "description" : "Filter by employee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[picsTakenEmployee]", "in" : "query", "description" : "Filter by picsTakenEmployee (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionnaireAnswers]", "in" : "query", "description" : "Filter by questionnaireAnswers (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[policyDropOffEstimates]", "in" : "query", "description" : "Filter by policyDropOffEstimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[estimates]", "in" : "query", "description" : "Filter by estimates (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[questionaireAnswersVersions]", "in" : "query", "description" : "Filter by questionaireAnswersVersions (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/InvestigationsFields" }, { "$ref" : "#/components/parameters/InvestigationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/InvestigationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/storageVolumes/{id}" : { "get" : { "description" : "Retrieve a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" }, { "$ref" : "#/components/parameters/StorageVolumesFields" }, { "$ref" : "#/components/parameters/StorageVolumesInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourceResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a StorageVolumes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a StorageVolumes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/storageVolumes" : { "get" : { "description" : "Retrieve a List of storageVolumes resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application_id]", "in" : "query", "description" : "Filter by application_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[protocol]", "in" : "query", "description" : "Filter by protocol (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[active]", "in" : "query", "description" : "Filter by active (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute1]", "in" : "query", "description" : "Filter by attribute1 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute2]", "in" : "query", "description" : "Filter by attribute2 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attribute3]", "in" : "query", "description" : "Filter by attribute3 (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[application]", "in" : "query", "description" : "Filter by application (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachments]", "in" : "query", "description" : "Filter by attachments (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/StorageVolumesFields" }, { "$ref" : "#/components/parameters/StorageVolumesInclude" }, { "$ref" : "#/components/parameters/StorageVolumesSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/StorageVolumesResourcesResponse" }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a StorageVolumes", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/StorageVolumesResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/storageVolumes/{id}/application" : { "get" : { "description" : "Retrieve applications related to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" }, { "$ref" : "#/components/parameters/ApplicationsFields" }, { "$ref" : "#/components/parameters/ApplicationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create storageVolumes relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete storageVolumes relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update storageVolumes relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/storageVolumes/{id}/attachments" : { "get" : { "description" : "Retrieve attachment related to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[volume_id]", "in" : "query", "description" : "Filter by volume_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[priv]", "in" : "query", "description" : "Filter by priv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filename]", "in" : "query", "description" : "Filter by filename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filetype]", "in" : "query", "description" : "Filter by filetype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filesize]", "in" : "query", "description" : "Filter by filesize (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_id]", "in" : "query", "description" : "Filter by attachment_entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_int]", "in" : "query", "description" : "Filter by pk1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_int]", "in" : "query", "description" : "Filter by pk2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_int]", "in" : "query", "description" : "Filter by pk3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_var]", "in" : "query", "description" : "Filter by pk1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_var]", "in" : "query", "description" : "Filter by pk2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_var]", "in" : "query", "description" : "Filter by pk3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[storageVolume]", "in" : "query", "description" : "Filter by storageVolume (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentEntity]", "in" : "query", "description" : "Filter by attachmentEntity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentFields" }, { "$ref" : "#/components/parameters/AttachmentInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/storageVolumes/{id}/relationships/application" : { "get" : { "description" : "Retrieve applications references related to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" }, { "$ref" : "#/components/parameters/ApplicationsFields" }, { "$ref" : "#/components/parameters/ApplicationsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create storageVolumes relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete storageVolumes relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" } ], "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update storageVolumes relationship to a applications resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "$ref" : "#/components/responses/ApplicationsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/ApplicationsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/shareddata/1.0/storageVolumes/{id}/relationships/attachments" : { "get" : { "description" : "Retrieve attachment references related to a storageVolumes resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/StorageVolumesPrimaryKey" }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[volume_id]", "in" : "query", "description" : "Filter by volume_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[priv]", "in" : "query", "description" : "Filter by priv (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[path]", "in" : "query", "description" : "Filter by path (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filename]", "in" : "query", "description" : "Filter by filename (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filetype]", "in" : "query", "description" : "Filter by filetype (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[filesize]", "in" : "query", "description" : "Filter by filesize (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_entity_id]", "in" : "query", "description" : "Filter by attachment_entity_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_int]", "in" : "query", "description" : "Filter by pk1_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_int]", "in" : "query", "description" : "Filter by pk2_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_int]", "in" : "query", "description" : "Filter by pk3_int (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk1_var]", "in" : "query", "description" : "Filter by pk1_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk2_var]", "in" : "query", "description" : "Filter by pk2_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[pk3_var]", "in" : "query", "description" : "Filter by pk3_var (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_on]", "in" : "query", "description" : "Filter by created_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[created_by]", "in" : "query", "description" : "Filter by created_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_on]", "in" : "query", "description" : "Filter by last_updated_on (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[last_updated_by]", "in" : "query", "description" : "Filter by last_updated_by (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[storageVolume]", "in" : "query", "description" : "Filter by storageVolume (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachmentEntity]", "in" : "query", "description" : "Filter by attachmentEntity (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentFields" }, { "$ref" : "#/components/parameters/AttachmentInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsCategorized/{id}" : { "get" : { "description" : "Retrieve a attachmentsCategorized resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsCategorizedPrimaryKey" }, { "$ref" : "#/components/parameters/AttachmentsCategorizedFields" }, { "$ref" : "#/components/parameters/AttachmentsCategorizedInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourceResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "delete" : { "description" : "Delete a AttachmentsCategorized", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsCategorizedPrimaryKey" } ], "responses" : { "200" : { "description" : "OK" }, "202" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "patch" : { "description" : "Update a AttachmentsCategorized", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsCategorizedPrimaryKey" } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsCategorizedPatchResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Info", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsCategorized" : { "get" : { "description" : "Retrieve a List of attachmentsCategorized resources", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/NestedFilter" }, { "name" : "filter[id]", "in" : "query", "description" : "Filter by id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[user_id]", "in" : "query", "description" : "Filter by user_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket_id]", "in" : "query", "description" : "Filter by ticket_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[attachment_id]", "in" : "query", "description" : "Filter by attachment_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[file_name]", "in" : "query", "description" : "Filter by file_name (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[generated_at]", "in" : "query", "description" : "Filter by generated_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[received_at]", "in" : "query", "description" : "Filter by received_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[photo_category]", "in" : "query", "description" : "Filter by photo_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lat]", "in" : "query", "description" : "Filter by lat (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[lon]", "in" : "query", "description" : "Filter by lon (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passed]", "in" : "query", "description" : "Filter by passed (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[account_number]", "in" : "query", "description" : "Filter by account_number (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passed_override_by_id]", "in" : "query", "description" : "Filter by passed_override_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[passed_override_at]", "in" : "query", "description" : "Filter by passed_override_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[purpose]", "in" : "query", "description" : "Filter by purpose (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[probability]", "in" : "query", "description" : "Filter by probability (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual_category]", "in" : "query", "description" : "Filter by manual_category (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual_category_at]", "in" : "query", "description" : "Filter by manual_category_at (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[manual_category_by_id]", "in" : "query", "description" : "Filter by manual_category_by_id (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[customer_facility_type]", "in" : "query", "description" : "Filter by customer_facility_type (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "name" : "filter[ticket]", "in" : "query", "description" : "Filter by ticket (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, { "$ref" : "#/components/parameters/AttachmentsCategorizedFields" }, { "$ref" : "#/components/parameters/AttachmentsCategorizedInclude" }, { "$ref" : "#/components/parameters/AttachmentsCategorizedSort" }, { "$ref" : "#/components/parameters/PageLimit" }, { "$ref" : "#/components/parameters/PageOffset" } ], "responses" : { "200" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourcesResponse" }, "202" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } }, "post" : { "description" : "Create a AttachmentsCategorized", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsCategorizedPostResource", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "responses" : { "201" : { "description" : "Created", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "202" : { "$ref" : "#/components/responses/AttachmentsCategorizedResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsCategorized/{id}/ticket" : { "get" : { "description" : "Retrieve tickets related to a attachmentsCategorized resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsCategorizedPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/ticketpro/1.0/attachmentsCategorized/{id}/relationships/ticket" : { "get" : { "description" : "Retrieve tickets references related to a attachmentsCategorized resource", "parameters" : [ { "name" : "Content-Type", "in" : "header", "required" : true, "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "application/vnd.api+json", "enum" : [ "application/vnd.api+json", "application/json" ] } }, { "$ref" : "#/components/parameters/AttachmentsCategorizedPrimaryKey" }, { "$ref" : "#/components/parameters/TicketsFields" }, { "$ref" : "#/components/parameters/TicketsInclude" } ], "responses" : { "200" : { "$ref" : "#/components/responses/TicketsResourceReferenceResponse" }, "202" : { "$ref" : "#/components/responses/TicketsResourceReferencesResponse" }, "204" : { "$ref" : "#/components/responses/NoContent" }, "400" : { "$ref" : "#/components/responses/400" }, "401" : { "$ref" : "#/components/responses/401" }, "403" : { "$ref" : "#/components/responses/403" }, "404" : { "$ref" : "#/components/responses/404" }, "405" : { "$ref" : "#/components/responses/405" }, "409" : { "$ref" : "#/components/responses/409" }, "412" : { "$ref" : "#/components/responses/412" }, "415" : { "$ref" : "#/components/responses/415" }, "422" : { "$ref" : "#/components/responses/422" }, "500" : { "$ref" : "#/components/responses/500" }, "501" : { "$ref" : "#/components/responses/501" }, "502" : { "$ref" : "#/components/responses/502" }, "503" : { "$ref" : "#/components/responses/503" }, "504" : { "$ref" : "#/components/responses/504" }, "505" : { "$ref" : "#/components/responses/505" } } } }, "/webauthn/register" : { "post" : { "tags" : [ "authentication-controller" ], "operationId" : "registerWebauthn", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebAuthnRegistrationRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/webauthn/register/options" : { "post" : { "tags" : [ "authentication-controller" ], "operationId" : "generateWebauthnRegistrationOptions", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebAuthnOptionsRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PublicKeyCredentialCreationOptions" } } } } } } } }, "/webauthn/authenticate" : { "post" : { "tags" : [ "authentication-controller", "unauthorized" ], "operationId" : "authenticateWebauthn", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebAuthnAuthenticationRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/webauthn/authenticate/options" : { "post" : { "tags" : [ "authentication-controller", "unauthorized" ], "operationId" : "generateWebauthnAuthenticationOptions", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebAuthnOptionsRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/PublicKeyCredentialRequestOptions" } } } } } } } }, "/trainingmanagement/2.0/notificationEvents" : { "get" : { "tags" : [ "training-management-controller-20" ], "operationId" : "notificationEventsHealth", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } }, "post" : { "tags" : [ "training-management-controller-20" ], "operationId" : "sendNotificationEvents", "parameters" : [ { "name" : "sessionId", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/trainingmanagement/2.0/conditionNotices" : { "post" : { "tags" : [ "training-management-controller-20" ], "operationId" : "sendConditionNotices", "parameters" : [ { "name" : "equipment", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/trainingmanagement/2.0/classCompletions" : { "post" : { "tags" : [ "training-management-controller-20" ], "operationId" : "recordClassCompletions", "parameters" : [ { "name" : "sessionId", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/trainingmanagement/2.0/approvalReminders" : { "post" : { "tags" : [ "training-management-controller-20" ], "operationId" : "sendApprovalReminders", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/ticketpro/2.0/ticketsByAddress" : { "post" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "ticketAddressReferences", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TicketAddressInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } } } } } }, "/ticketpro/2.0/locatesByAddress" : { "post" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "locatesAddressReferences", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TicketAddressInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } } } } } }, "/ticketpro/2.0/emailDigCheck" : { "post" : { "tags" : [ "ticket-pro-controller-20", "unauthorized" ], "operationId" : "sendDigCheckEmail", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DigCheckInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/ticketpro/1.0/ticketsByAddress" : { "post" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "ticketAddressReferences_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TicketAddressInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } } } } } }, "/ticketpro/1.0/locatesByAddress" : { "post" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "locatesAddressReferences_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TicketAddressInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } } } } } }, "/ticketpro/1.0/emailDigCheck" : { "post" : { "tags" : [ "ticket-pro-controller", "unauthorized" ], "operationId" : "sendDigCheckEmail_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DigCheckInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/slack" : { "post" : { "tags" : [ "slack-controller" ], "operationId" : "slack", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SlackMessage" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebhookResponse" } } } } } } }, "/shareddata/2.0/attachment" : { "post" : { "tags" : [ "shared-data-controller-20" ], "operationId" : "uploadFile", "parameters" : [ { "name" : "files", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "binary" } } }, { "name" : "entityName", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "entityId", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UploadResponse" } } } } } } } }, "/shareddata/1.0/attachment" : { "post" : { "tags" : [ "shared-data-controller" ], "operationId" : "uploadFile_1", "parameters" : [ { "name" : "files", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string", "format" : "binary" } } }, { "name" : "entityName", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "entityId", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UploadResponse" } } } } } } } }, "/scheduler/1.0/deleteJob" : { "post" : { "tags" : [ "scheduler-controller" ], "operationId" : "deleteJob", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/JobInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/reports/2.0/report/{reportId}" : { "get" : { "tags" : [ "reports-controller-20" ], "operationId" : "getReport", "parameters" : [ { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } }, "post" : { "tags" : [ "reports-controller-20" ], "operationId" : "scheduleReport", "parameters" : [ { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/reports/2.0/excel/assetHistoryReport" : { "post" : { "tags" : [ "reports-controller-20" ], "operationId" : "assetHistoryReport", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssetsHistoryRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/reports/1.0/report/{reportId}" : { "get" : { "tags" : [ "reports-controller" ], "operationId" : "getReport_1", "parameters" : [ { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } }, "post" : { "tags" : [ "reports-controller" ], "operationId" : "scheduleReport_1", "parameters" : [ { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/reports/1.0/excel/assetHistoryReport" : { "post" : { "tags" : [ "reports-controller" ], "operationId" : "assetHistoryReport_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AssetsHistoryRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/renew" : { "post" : { "tags" : [ "authentication-controller", "unauthorized" ], "operationId" : "renew", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RenewalRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/feedback" : { "post" : { "tags" : [ "reference-feedback-controller" ], "operationId" : "feedback", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FeedbackRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/FeedbackRecord" } } } } } } }, "/reference/2.0/ask" : { "post" : { "tags" : [ "reference-ask-controller" ], "operationId" : "ask", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AskRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Answer" } } } } } } }, "/reference/2.0/admin/ingest" : { "post" : { "tags" : [ "reference-admin-controller" ], "operationId" : "ingest", "parameters" : [ { "name" : "binder", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/ingest/all" : { "post" : { "tags" : [ "reference-admin-controller" ], "operationId" : "ingestAll", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/index/rebuild" : { "post" : { "tags" : [ "reference-admin-controller" ], "operationId" : "rebuildIndex", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/eval/run" : { "post" : { "tags" : [ "reference-eval-controller" ], "operationId" : "run", "parameters" : [ { "name" : "limit", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "ids", "in" : "query", "required" : false, "schema" : { "type" : "string", "default" : "" } }, { "name" : "paraphrases", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : false } }, { "name" : "scope", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : false } }, { "name" : "model", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "effort", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "maxTokens", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/eval/compare" : { "post" : { "tags" : [ "reference-eval-controller" ], "operationId" : "compare", "parameters" : [ { "name" : "configs", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "limit", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "ids", "in" : "query", "required" : false, "schema" : { "type" : "string", "default" : "" } }, { "name" : "paraphrases", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : false } }, { "name" : "scope", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/binders/{binder}/retire" : { "post" : { "tags" : [ "reference-admin-controller" ], "operationId" : "retireBinder", "parameters" : [ { "name" : "binder", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/messaging/2.0/sendSms" : { "post" : { "tags" : [ "messaging-controller-20" ], "operationId" : "sendSms", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessageRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskEmployeeMessageResponseList" } } } } } } }, "/messaging/2.0/employeeMessages" : { "post" : { "tags" : [ "employee-message-controller-20" ], "operationId" : "create", "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } } } } } } }, "/messaging/2.0/deviceTokens" : { "post" : { "tags" : [ "device-token-controller-20" ], "operationId" : "register", "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } } } } } } }, "/messaging/2.0/batchSend" : { "post" : { "tags" : [ "messaging-controller-20" ], "operationId" : "batchMulticast", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessageRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskEmployeeMessageResponseList" } } } } } } }, "/messaging/1.0/sendSms" : { "post" : { "tags" : [ "messaging-controller" ], "operationId" : "sendSms_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessageRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskEmployeeMessageResponseList" } } } } } } }, "/messaging/2.0/sendEmail" : { "post" : { "tags" : [ "messaging-controller" ], "operationId" : "sendEmail", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessageRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessageResponseList" } } } } } } }, "/messaging/1.0/sendEmail" : { "post" : { "tags" : [ "messaging-controller" ], "operationId" : "sendEmail_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessageRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessageResponseList" } } } } } } }, "/messaging/1.0/oldBatchSend" : { "post" : { "tags" : [ "messaging-controller" ], "operationId" : "batchSend", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessageRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskEmployeeMessageResponseList" } } } } } } }, "/messaging/1.0/batchSend" : { "post" : { "tags" : [ "messaging-controller" ], "operationId" : "batchMulticast_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessageRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskEmployeeMessageResponseList" } } } } } } }, "/impersonate" : { "post" : { "tags" : [ "authentication-controller" ], "operationId" : "impersonationRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ImpersonationRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/idea/2.0/moderation" : { "post" : { "tags" : [ "idea-moderation-controller" ], "operationId" : "check", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CheckRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/customerportal/2.0/updateCustomerAccess" : { "post" : { "tags" : [ "customer-portal-access-controller-20" ], "operationId" : "updateCustomerAccess", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/customerportal/2.0/ticketTypeForTicketBucket" : { "post" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getTicketTypeForTicketBucket", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } } } }, "/customerportal/2.0/requestMSUser" : { "post" : { "tags" : [ "customer-portal-access-controller-20", "unauthorized" ], "operationId" : "requestManagedServicesUser", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CPManagedServicesUser" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/customerportal/2.0/registerUserEmail" : { "post" : { "tags" : [ "customer-portal-controller-20", "unauthorized" ], "operationId" : "registerUserEmail", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerPortalUser" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/customerportal/2.0/locByWorkDoneFor" : { "post" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getLocByWorkDoneFor", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/customerportal/2.0/locByTicketBucket" : { "post" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getLocByTicketBucket", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/customerportal/2.0/locByExcavator" : { "post" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getLocByExcavator", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/customerportal/2.0/getGpsZipData" : { "post" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getGpsZipData", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GpsData" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "byte" } } } } } } }, "/customerportal/1.0/updateCustomerAccess" : { "post" : { "tags" : [ "customer-portal-controller" ], "operationId" : "updateCustomerAccess_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/customerportal/1.0/ticketTypeForTicketBucket" : { "post" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getTicketTypeForTicketBucket_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } } } }, "/customerportal/1.0/requestMSUser" : { "post" : { "tags" : [ "customer-portal-controller", "unauthorized" ], "operationId" : "registerManagedServicesUserEmail", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CPManagedServicesUser" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/customerportal/1.0/registerUserEmail" : { "post" : { "tags" : [ "customer-portal-controller", "unauthorized" ], "operationId" : "registerUserEmail_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerPortalUser" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/customerportal/1.0/locByWorkDoneFor" : { "post" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getLocByWorkDoneFor_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/customerportal/1.0/locByTicketBucket" : { "post" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getLocByTicketBucket_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/customerportal/1.0/locByExcavator" : { "post" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getLocByExcavator_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/customerportal/1.0/getGpsZipData" : { "post" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getGpsZipData_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GpsData" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "byte" } } } } } } }, "/cpImpersonate" : { "post" : { "tags" : [ "authentication-controller" ], "operationId" : "cpImpersonationRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ImpersonationRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/cms/2.0/createDamage" : { "post" : { "tags" : [ "cms-controller-20" ], "operationId" : "createDamage", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDamageRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/cms/1.0/createDamage" : { "post" : { "tags" : [ "cms-controller" ], "operationId" : "createDamage_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateDamageRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/verizonServiceActivation" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "verizonServiceActivation20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VerizonOrderInfoRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/2.0/verizonMtn" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "verizonMtnRequest20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VerizonOrderInfoRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonStatusResponse" } } } } } } }, "/assetmanager/2.0/verizonLookup" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "verizonLookupRequest20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VerizonLookupRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonResponse" } } } } } } }, "/assetmanager/2.0/updatePumpDevice" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "updatePumpDevice", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PumpDeviceUpsertRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/2.0/scheduleVerizonInventory" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "scheduleVerizonInventory20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/scheduleVerizonCurrentUsage" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "scheduleVerizonCurrentUsage20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/scheduleVerizonCurrentUsageSummary" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "scheduleVerizonCurrentUsageSummary20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/scheduleAttWirelessInventoryReport" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "scheduleAttWirelessInventoryReport20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/scheduleAttCurrentUsageReport" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "scheduleAttCurrentUsageReport20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/scheduleAttCatalogExtract" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "scheduleAttCatalogExtract20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/createAsset" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "attCareOrderRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Asset" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Asset" } } } } } } }, "/assetmanager/2.0/bulkWirelessRequest" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "bulkWirelessRequest20", "parameters" : [ { "name" : "request", "in" : "query", "required" : true, "schema" : { "$ref" : "#/components/schemas/WirelessRequest" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskResponseEntityListWirelessResponse" } } } } } } }, "/assetmanager/2.0/attWirelessInventoryReport" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "attWirelessInventoryReport20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/UsicSoapResponse" } } } } } } }, "/assetmanager/2.0/attTradeInDeviceReport" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "attTradeInDeviceReport20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ReqRepResponse" } } } } } } }, "/assetmanager/2.0/attRequestReport" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "attRequestReport20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ReqRepResponse" } } } } } } }, "/assetmanager/2.0/attCurrentUsageReport" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "attCurrentUsageReport20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/2.0/attCareOrderRequest" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "attCareOrderRequest20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttCareOrderRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WirelessResponse" } } } } } } } }, "/assetmanager/2.0/attCareAccountInformationRequest" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "attCareAccountInformationRequest20", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CareOrderResponse2" } } } } } } }, "/assetmanager/2.0/assets" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "createAssetJsonApi", "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/assetRegistration" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "assetRegistration", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransloreRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/2.0/assetBulk" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "uploadFile20", "parameters" : [ { "name" : "request", "in" : "query", "required" : true, "schema" : { "$ref" : "#/components/schemas/BulkRequest" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskResponseEntityObject" } } } } } } }, "/assetmanager/2.0/assetAssignmentBulk" : { "post" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "uploadAssignmentFile20", "parameters" : [ { "name" : "request", "in" : "query", "required" : true, "schema" : { "$ref" : "#/components/schemas/BulkAssignmentRequest" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskResponseEntityObject" } } } } } } }, "/assetmanager/1.0/verizonServiceActivation" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "verizonServiceActivation", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VerizonOrderInfoRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/1.0/verizonMtn" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "verizonMtnRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VerizonOrderInfoRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonStatusResponse" } } } } } } }, "/assetmanager/1.0/verizonLookup" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "verizonLookupRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VerizonLookupRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonResponse" } } } } } } }, "/assetmanager/1.0/scheduleVerizonInventory" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "scheduleVerizonInventory", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/scheduleVerizonCurrentUsage" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "scheduleVerizonCurrentUsage", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/scheduleVerizonCurrentUsageSummary" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "scheduleVerizonCurrentUsageSummary", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/scheduleAttWirelessInventoryReport" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "scheduleAttWirelessInventoryReport", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/scheduleAttCurrentUsageReport" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "scheduleAttCurrentUsageReport", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/scheduleAttCatalogExtract" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "scheduleAttCatalogExtract", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UsicWirelessSchedulerInfo" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/bulkWirelessRequest" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "bulkWirelessRequest", "parameters" : [ { "name" : "request", "in" : "query", "required" : true, "schema" : { "$ref" : "#/components/schemas/WirelessRequest" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskResponseEntityListWirelessResponse" } } } } } } }, "/assetmanager/1.0/attWirelessInventoryReport" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "attWirelessInventoryReport", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/UsicSoapResponse" } } } } } } }, "/assetmanager/1.0/attTradeInDeviceReport" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "attTradeInDeviceReport", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ReqRepResponse" } } } } } } }, "/assetmanager/1.0/attRequestReport" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "attRequestReport", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ReqRepResponse" } } } } } } }, "/assetmanager/1.0/attCurrentUsageReport" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "attCurrentUsageReport", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/1.0/attCareOrderRequest" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "attCareOrderRequest_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttCareOrderRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WirelessResponse" } } } } } } } }, "/assetmanager/1.0/attCareAccountInformationRequest" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "attCareAccountInformationRequest", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AttMessageHeader" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CareOrderResponse2" } } } } } } }, "/assetmanager/1.0/assetRegistration" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "assetRegistration_1", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TransloreRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/1.0/assetBulk" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "uploadFile_2", "parameters" : [ { "name" : "request", "in" : "query", "required" : true, "schema" : { "$ref" : "#/components/schemas/BulkRequest" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskResponseEntityObject" } } } } } } }, "/assetmanager/1.0/assetAssignmentBulk" : { "post" : { "tags" : [ "asset-manager-controller" ], "operationId" : "uploadAssignmentFile", "parameters" : [ { "name" : "request", "in" : "query", "required" : true, "schema" : { "$ref" : "#/components/schemas/BulkAssignmentRequest" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskResponseEntityObject" } } } } } } }, "/assetmanager/2.0/assets/{assetId}" : { "delete" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "deleteAsset", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } }, "patch" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "patchAssetVersioned", "parameters" : [ { "name" : "assetId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JsonApiDocumentJsonApiResourceMapStringObject" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/JsonApiDocumentJsonApiResourceMapStringObject" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/assetAttributeValues/{id}" : { "delete" : { "tags" : [ "asset-attribute-value-controller-20" ], "operationId" : "delete", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } }, "patch" : { "tags" : [ "asset-attribute-value-controller-20" ], "operationId" : "patch", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/assetAssignments/{id}" : { "delete" : { "tags" : [ "asset-assignment-controller-20" ], "operationId" : "delete_1", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } }, "patch" : { "tags" : [ "asset-assignment-controller-20" ], "operationId" : "patch_1", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } }, "required" : true }, "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/{namespace}/2.0/{collection}/{ids}" : { "get" : { "tags" : [ "elide-multiple-ids-controller" ], "operationId" : "findByIds", "parameters" : [ { "name" : "namespace", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "collection", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "ids", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "type" : "string" } }, "application/json" : { "schema" : { "type" : "string" } } } } } } }, "/validate" : { "get" : { "tags" : [ "authentication-controller", "unauthorized" ], "operationId" : "azureAuthenticationRequest", "parameters" : [ { "name" : "accessToken", "in" : "query", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/trainingmanagement/2.0/usicHolidays" : { "get" : { "tags" : [ "training-management-controller-20" ], "operationId" : "usicHolidays", "parameters" : [ { "name" : "from", "in" : "query", "required" : false, "schema" : { "type" : "string", "format" : "date" } }, { "name" : "to", "in" : "query", "required" : false, "schema" : { "type" : "string", "format" : "date" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/trainingmanagement/2.0/sessionStatusCounts" : { "get" : { "tags" : [ "training-management-controller-20" ], "operationId" : "getSessionStatusCounts", "parameters" : [ { "name" : "district", "in" : "query", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "name" : "region", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/trainingmanagement/2.0/needsRequestSheet" : { "get" : { "tags" : [ "training-management-controller-20" ], "operationId" : "needsRequestSheet", "parameters" : [ { "name" : "district", "in" : "query", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "name" : "region", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "byte" } } } } } } }, "/trainingmanagement/2.0/courseCadence" : { "get" : { "tags" : [ "training-management-controller-20" ], "operationId" : "getCourseCadence", "parameters" : [ { "name" : "district", "in" : "query", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } }, { "name" : "region", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/ticketpro/2.0/topMetrics" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "getTopMetrics", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/2.0/ticketInRadius" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "getTicketInRadius", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/ticketpro/2.0/serviceStops" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "getServiceStop", "parameters" : [ { "name" : "ticketId", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "visitsId", "in" : "query", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/ticketpro/2.0/openTicketCountsByWorkDoneFor" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "getOpenTicketCountsByWorkDoneFor", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/2.0/openTicketCountsByTicketType" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "getOpenTicketCountsByTicketType", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/2.0/openTicketCountsByState" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "getOpenTicketCountsByState", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/2.0/openTicketCountsByExcavator" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "getOpenTicketCountsByExcavator", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/2.0/6MoVolumeByTicketType" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "get6MoVolumeByTicketType", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "start_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "end_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/2.0/6MoTimelinessVolumeByState" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "get6MoTimelinessVolumeByState", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "start_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "end_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/2.0/6MoTicketCountsByTicketType" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "get6MoTicketCountsByTicketType", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "start_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "end_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/2.0/6MoLongScope" : { "get" : { "tags" : [ "ticket-pro-controller-20" ], "operationId" : "get6MoLongScope", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "start_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "end_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/1.0/topMetrics" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "getTopMetrics_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/1.0/ticketInRadius" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "getTicketInRadius_1", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/ticketpro/1.0/serviceStops" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "getServiceStop_1", "parameters" : [ { "name" : "ticketId", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "visitsId", "in" : "query", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/ticketpro/1.0/openTicketCountsByWorkDoneFor" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "getOpenTicketCountsByWorkDoneFor_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/1.0/openTicketCountsByTicketType" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "getOpenTicketCountsByTicketType_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/1.0/openTicketCountsByState" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "getOpenTicketCountsByState_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/1.0/openTicketCountsByExcavator" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "getOpenTicketCountsByExcavator_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/1.0/6MoVolumeByTicketType" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "get6MoVolumeByTicketType_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "start_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "end_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/1.0/6MoTimelinessVolumeByState" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "get6MoTimelinessVolumeByState_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "start_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "end_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/1.0/6MoTicketCountsByTicketType" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "get6MoTicketCountsByTicketType_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "start_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "end_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/ticketpro/1.0/6MoLongScope" : { "get" : { "tags" : [ "ticket-pro-controller" ], "operationId" : "get6MoLongScope_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } }, { "name" : "states", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "start_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "end_date", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/shareddata/2.0/attachment/{attachmentId}" : { "get" : { "tags" : [ "shared-data-controller-20" ], "operationId" : "downloadFile", "parameters" : [ { "name" : "attachmentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } }, { "name" : "Accept", "in" : "header", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/shareddata/1.0/attachment/{attachmentId}" : { "get" : { "tags" : [ "shared-data-controller" ], "operationId" : "downloadFile_1", "parameters" : [ { "name" : "attachmentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/secureAccess/2.0/users" : { "get" : { "tags" : [ "secure-access-controller-20" ], "operationId" : "getUsers", "parameters" : [ { "name" : "name", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "group", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "pageSize", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "page", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 1 } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } } } } } } }, "/secureAccess/2.0/sessions" : { "get" : { "tags" : [ "secure-access-controller-20" ], "operationId" : "getSessionStatuses", "parameters" : [ { "name" : "name", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "group", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "serverName", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } } } } } } }, "/secureAccess/2.0/devices" : { "get" : { "tags" : [ "secure-access-controller-20" ], "operationId" : "getDevices", "parameters" : [ { "name" : "name", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "group", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "state", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "pageSize", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "page", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 1 } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } } } } } } }, "/secureAccess/1.0/users" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getUsers_1", "parameters" : [ { "name" : "name", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "group", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "pageSize", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "page", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 1 } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } } } } } } }, "/secureAccess/1.0/sessions" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getSessionStatuses_1", "parameters" : [ { "name" : "name", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "group", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "serverName", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } } } } } } }, "/secureAccess/1.0/devices" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getDevices_1", "parameters" : [ { "name" : "name", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "group", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "state", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "pageSize", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "page", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 1 } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/JsonNode" } } } } } } }, "/scheduler/1.0/getSchedulerInfo" : { "get" : { "tags" : [ "scheduler-controller" ], "operationId" : "getSchedulerInfo", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/reports/2.0/excel/{resource}" : { "get" : { "tags" : [ "reports-controller-20" ], "operationId" : "excelReport", "parameters" : [ { "name" : "resource", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/reports/2.0/datasourceConnections" : { "get" : { "tags" : [ "reports-controller-20" ], "operationId" : "getConnections", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } } } } } } }, "/reports/1.0/excel/{resource}" : { "get" : { "tags" : [ "reports-controller" ], "operationId" : "excelReport_1", "parameters" : [ { "name" : "resource", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/reference/2.0/documents/{documentId}/pages/{pageNumber}/image" : { "get" : { "tags" : [ "reference-page-image-controller" ], "operationId" : "image", "parameters" : [ { "name" : "documentId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "pageNumber", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/reference/2.0/binders" : { "get" : { "tags" : [ "reference-corpus-controller" ], "operationId" : "binders", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BinderSummary" } } } } } } } }, "/reference/2.0/admin/usage/daily" : { "get" : { "tags" : [ "reference-usage-controller" ], "operationId" : "daily", "parameters" : [ { "name" : "from", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "to", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "source", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/reference/2.0/admin/spend" : { "get" : { "tags" : [ "reference-spend-controller" ], "operationId" : "spend", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/reference/2.0/admin/search" : { "get" : { "tags" : [ "reference-admin-controller" ], "operationId" : "search", "parameters" : [ { "name" : "q", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "binder", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "k", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32", "default" : 10 } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/retrieve" : { "get" : { "tags" : [ "reference-admin-controller" ], "operationId" : "retrieve", "parameters" : [ { "name" : "q", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "binder", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/model-usage" : { "get" : { "tags" : [ "model-usage-controller" ], "operationId" : "byApplication", "parameters" : [ { "name" : "from", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "to", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } }, "/reference/2.0/admin/ingest/binders" : { "get" : { "tags" : [ "reference-admin-controller" ], "operationId" : "binderFolders", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/feedback" : { "get" : { "tags" : [ "reference-feedback-controller" ], "operationId" : "export", "parameters" : [ { "name" : "verdict", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "since", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/FeedbackExportRow" } } } } } } } }, "/reference/2.0/admin/eval/runs" : { "get" : { "tags" : [ "reference-eval-controller" ], "operationId" : "runs", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } } } }, "/reference/2.0/admin/eval/runs/{runId}" : { "get" : { "tags" : [ "reference-eval-controller" ], "operationId" : "run_1", "parameters" : [ { "name" : "runId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/eval/runs/{runId}/summary" : { "get" : { "tags" : [ "reference-eval-controller" ], "operationId" : "summary", "parameters" : [ { "name" : "runId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/reference/2.0/admin/eval/retrieval" : { "get" : { "tags" : [ "reference-eval-controller" ], "operationId" : "retrieval", "parameters" : [ { "name" : "topK", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "neighbours", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "maxPages", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "paraphrases", "in" : "query", "required" : false, "schema" : { "type" : "boolean", "default" : false } }, { "name" : "hybrid", "in" : "query", "required" : false, "schema" : { "type" : "boolean" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/eval/field-cases" : { "get" : { "tags" : [ "reference-eval-controller" ], "operationId" : "fieldCases", "parameters" : [ { "name" : "since", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "minConfirmations", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/eval/field-cases/digest" : { "get" : { "tags" : [ "reference-eval-controller" ], "operationId" : "fieldCasesDigest", "parameters" : [ { "name" : "since", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/reference/2.0/admin/eval/comparisons" : { "get" : { "tags" : [ "reference-eval-controller" ], "operationId" : "comparisonList", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } } } } }, "/reference/2.0/admin/eval/comparisons/{id}" : { "get" : { "tags" : [ "reference-eval-controller" ], "operationId" : "comparison", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "object" } } } } } } }, "/reference/2.0/admin/eval/comparisons/{id}/table" : { "get" : { "tags" : [ "reference-eval-controller" ], "operationId" : "comparisonTable", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/openapi.json" : { "get" : { "tags" : [ "doc-controller", "unauthorized" ], "operationId" : "getOpenApi", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/openapi-2.0.json" : { "get" : { "tags" : [ "doc-controller", "unauthorized" ], "operationId" : "getOpenApi20", "responses" : { "200" : { "description" : "OK", "content" : { "application/json" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/favicon.ico" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/usic-logo-fullcolor.svg" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_1", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/usic-logo-white-color.svg" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_2", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/favicon.icns" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_3", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/openapi-2.0-openapi-explorer.html" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_4", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/openapi-openapi-explorer.html" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_5", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_6", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/index.css" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_7", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/openapi-2.0-rapidoc.html" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_8", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/openapi-2.0-elements.html" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_9", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/openapi-rapidoc.html" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_10", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/index.html" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_11", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/openapi-elements.html" : { "get" : { "tags" : [ "reports-controller", "unauthorized" ], "operationId" : "serveStatic_12", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/ninjaone/2.0/devices" : { "get" : { "tags" : [ "jsonapi-ninja-one-controller-20" ], "operationId" : "getDevices_2", "parameters" : [ { "name" : "df", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceNinjaOne" } } } } } } } }, "/ninjaone/2.0/devicesSearch/{serialNumber}" : { "get" : { "tags" : [ "jsonapi-ninja-one-controller-20" ], "operationId" : "getDeviceBySerialNumber", "parameters" : [ { "name" : "serialNumber", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/DeviceNinjaOne" } } } } } } }, "/ninjaone/2.0/devices/{deviceId}" : { "get" : { "tags" : [ "jsonapi-ninja-one-controller-20" ], "operationId" : "getDeviceById", "parameters" : [ { "name" : "deviceId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/DeviceNinjaOne" } } } } } } }, "/ninjaone/2.0/deviceAssignments/{employeeId}" : { "get" : { "tags" : [ "jsonapi-ninja-one-controller-20" ], "operationId" : "getDeviceAssignments", "parameters" : [ { "name" : "employeeId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceNinjaOne" } } } } } } } }, "/ninjaone/1.0/devices" : { "get" : { "tags" : [ "jsonapi-ninja-one-controller" ], "operationId" : "getDevices_3", "parameters" : [ { "name" : "df", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceNinjaOne" } } } } } } } }, "/ninjaone/1.0/devicesSearch/{serialNumber}" : { "get" : { "tags" : [ "jsonapi-ninja-one-controller" ], "operationId" : "getDeviceBySerialNumber_1", "parameters" : [ { "name" : "serialNumber", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/DeviceNinjaOne" } } } } } } }, "/ninjaone/1.0/devices/{deviceId}" : { "get" : { "tags" : [ "jsonapi-ninja-one-controller" ], "operationId" : "getDeviceById_1", "parameters" : [ { "name" : "deviceId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int32" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/DeviceNinjaOne" } } } } } } }, "/ninjaone/1.0/deviceAssignments/{employeeId}" : { "get" : { "tags" : [ "jsonapi-ninja-one-controller" ], "operationId" : "getDeviceAssignments_1", "parameters" : [ { "name" : "employeeId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceNinjaOne" } } } } } } } }, "/managedServices/2.0/topMetrics" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "getTopMetrics_2", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/openTickets" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "getOpenTickets", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/openTicketCountsByWorkDoneFor" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "getOpenTicketCountsByWorkDoneFor_2", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/openTicketCountsByTicketType" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "getOpenTicketCountsByTicketType_2", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/openTicketCountsByState" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "getOpenTicketCountsByState_2", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/openTicketCountsByExcavator" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "getOpenTicketCountsByExcavator_2", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/openTicketBoreFootageByExcavator" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "getOpenTicketBoreFootageByExcavator", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/laborUnits" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "getLaborUnits", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/availableProjectOwners" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "getAvailableProjectOwners", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/6MoVolumeByTicketType" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "get6MoVolumeByTicketType_2", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/6MoTimelinessVolumeByState" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "get6MoTimelinessVolumeByState_2", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/6MoTicketCountsByTicketType" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "get6MoTicketCountsByTicketType_2", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/6MoHistoricalData" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "get6MoHistoricalData", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/6MoDataSet" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "get6MoDataSet", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/6MoBoreFootageByFootageBucket" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "get6MoBoreFootageByFootageBucket", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/6MoBoreFootageByExcavator" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "get6MoBoreFootageByExcavator", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/2.0/30DayDataSet" : { "get" : { "tags" : [ "managed-services-controller-20" ], "operationId" : "get30DayDataSet", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/topMetrics" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "getTopMetrics_3", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/openTickets" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "getOpenTickets_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/openTicketCountsByWorkDoneFor" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "getOpenTicketCountsByWorkDoneFor_3", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/openTicketCountsByTicketType" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "getOpenTicketCountsByTicketType_3", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/openTicketCountsByState" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "getOpenTicketCountsByState_3", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/openTicketCountsByExcavator" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "getOpenTicketCountsByExcavator_3", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/openTicketBoreFootageByExcavator" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "getOpenTicketBoreFootageByExcavator_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/laborUnits" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "getLaborUnits_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/availableProjectOwners" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "getAvailableProjectOwners_1", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/6MoVolumeByTicketType" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "get6MoVolumeByTicketType_3", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/6MoTimelinessVolumeByState" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "get6MoTimelinessVolumeByState_3", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/6MoTicketCountsByTicketType" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "get6MoTicketCountsByTicketType_3", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/6MoHistoricalData" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "get6MoHistoricalData_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/6MoDataSet" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "get6MoDataSet_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/6MoBoreFootageByFootageBucket" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "get6MoBoreFootageByFootageBucket_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/6MoBoreFootageByExcavator" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "get6MoBoreFootageByExcavator_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/managedServices/1.0/30DayDataSet" : { "get" : { "tags" : [ "managed-services-controller" ], "operationId" : "get30DayDataSet_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/generateRestApi" : { "get" : { "tags" : [ "doc-controller" ], "operationId" : "getGenRestOpenApi", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/datasourceConnections" : { "get" : { "tags" : [ "reports-controller" ], "operationId" : "getConnections_1", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } } } } } } }, "/customerportal/2.0/tpHistories/{ticketId}" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getTpHistories", "parameters" : [ { "name" : "ticketId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JsonApiDocumentJsonApiResourceTpHistoryAttributes" } }, "application/json" : { "schema" : { "$ref" : "#/components/schemas/JsonApiDocumentJsonApiResourceTpHistoryAttributes" } } } } } } }, "/customerportal/2.0/receivedTicketsYear" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getReceivedTicketsYear", "parameters" : [ { "name" : "accountNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "contractNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReceivedTicketsYearResponse" } } } } } } } }, "/customerportal/2.0/receivedTicketsWeek" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getReceivedTicketsWeek", "parameters" : [ { "name" : "accountNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "contractNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReceivedTicketsWeekResponse" } } } } } } } }, "/customerportal/2.0/openTickets" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getOpenTickets_2", "parameters" : [ { "name" : "accountNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "contractNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "integer", "format" : "int32" } } } } } } }, "/customerportal/2.0/loginsByAccountYearly" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getLoginsByAccountYearly", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LoginsByAccountYearlyResponse" } } } } } } } }, "/customerportal/2.0/loginsByAccountUserYearly" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getLoginsByAccountUserYearly", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LoginsByAccountUserYearlyResponse" } } } } } } } }, "/customerportal/2.0/loginsByAccountUserMonthly" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getLoginsByAccountUserMonthly", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LoginsByAccountUserMonthlyResponse" } } } } } } } }, "/customerportal/2.0/loginsByAccountMonthly" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getLoginsByAccountMonthly", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LoginsByAccountMonthlyResponse" } } } } } } } }, "/customerportal/2.0/forgotPassword" : { "get" : { "tags" : [ "customer-portal-controller-20", "unauthorized" ], "operationId" : "processForgotPasswordForm", "parameters" : [ { "name" : "email", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "username", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/customerportal/2.0/datasourceConnections" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getConnections_2", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/customerportal/2.0/damagePhoto/{attachmentId}" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getDamagePhoto", "parameters" : [ { "name" : "attachmentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/customerportal/2.0/closedTickets" : { "get" : { "tags" : [ "customer-portal-controller-20" ], "operationId" : "getClosedTickets", "parameters" : [ { "name" : "accountNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "contractNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "integer", "format" : "int32" } } } } } } }, "/customerportal/1.0/receivedTicketsYear" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getReceivedTicketsYear_1", "parameters" : [ { "name" : "accountNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "contractNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReceivedTicketsYearResponse" } } } } } } } }, "/customerportal/1.0/receivedTicketsWeek" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getReceivedTicketsWeek_1", "parameters" : [ { "name" : "accountNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "contractNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReceivedTicketsWeekResponse" } } } } } } } }, "/customerportal/1.0/openTickets" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getOpenTickets_3", "parameters" : [ { "name" : "accountNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "contractNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "integer", "format" : "int32" } } } } } } }, "/customerportal/1.0/loginsByAccountYearly" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getLoginsByAccountYearly_1", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LoginsByAccountYearlyResponse" } } } } } } } }, "/customerportal/1.0/loginsByAccountUserYearly" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getLoginsByAccountUserYearly_1", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LoginsByAccountUserYearlyResponse" } } } } } } } }, "/customerportal/1.0/loginsByAccountUserMonthly" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getLoginsByAccountUserMonthly_1", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LoginsByAccountUserMonthlyResponse" } } } } } } } }, "/customerportal/1.0/loginsByAccountMonthly" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getLoginsByAccountMonthly_1", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LoginsByAccountMonthlyResponse" } } } } } } } }, "/customerportal/1.0/forgotPassword" : { "get" : { "tags" : [ "customer-portal-controller", "unauthorized" ], "operationId" : "processForgotPasswordForm_1", "parameters" : [ { "name" : "email", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "username", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "boolean" } } } } } } }, "/customerportal/1.0/datasourceConnections" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getConnections_3", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/customerportal/1.0/damagePhoto/{attachmentId}" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getDamagePhoto_1", "parameters" : [ { "name" : "attachmentId", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/customerportal/1.0/closedTickets" : { "get" : { "tags" : [ "customer-portal-controller" ], "operationId" : "getClosedTickets_1", "parameters" : [ { "name" : "accountNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "name" : "contractNumbers", "in" : "query", "required" : true, "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "integer", "format" : "int32" } } } } } } }, "/cms/2.0/topMetrics" : { "get" : { "tags" : [ "cms-controller-20" ], "operationId" : "getTopMetrics_4", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/cms/2.0/6MoDamagesByTicketType" : { "get" : { "tags" : [ "cms-controller-20" ], "operationId" : "get6MoDamagesByTicketType", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/cms/2.0/6MoDamagesByReason" : { "get" : { "tags" : [ "cms-controller-20" ], "operationId" : "get6MoDamagesByReason", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/cms/2.0/6MoDamagesByMonthState" : { "get" : { "tags" : [ "cms-controller-20" ], "operationId" : "get6MoDamagesByMonthState", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/cms/2.0/6MoDamagesByExcavator" : { "get" : { "tags" : [ "cms-controller-20" ], "operationId" : "get6MoDamagesByExcavator", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/cms/1.0/topMetrics" : { "get" : { "tags" : [ "cms-controller" ], "operationId" : "getTopMetrics_5", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/cms/1.0/6MoDamagesByTicketType" : { "get" : { "tags" : [ "cms-controller" ], "operationId" : "get6MoDamagesByTicketType_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/cms/1.0/6MoDamagesByReason" : { "get" : { "tags" : [ "cms-controller" ], "operationId" : "get6MoDamagesByReason_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/cms/1.0/6MoDamagesByMonthState" : { "get" : { "tags" : [ "cms-controller" ], "operationId" : "get6MoDamagesByMonthState_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/cms/1.0/6MoDamagesByExcavator" : { "get" : { "tags" : [ "cms-controller" ], "operationId" : "get6MoDamagesByExcavator_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/assetmanager/2.0/verizonCheckStatus" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "verizonCheckStatusRequest20", "parameters" : [ { "name" : "refNumber", "in" : "query", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonStatusResponse" } } } } } } }, "/assetmanager/2.0/verizonAuthenticationTest" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "verizonAuthenticationTest20", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/verifyEquipment" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "verifyEquipment20", "parameters" : [ { "name" : "employeeId", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "pickDate", "in" : "query", "required" : false, "schema" : { "type" : "string", "format" : "date" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/2.0/updateVerizonUsage" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getVerizonUsageFile20", "parameters" : [ { "name" : "usageType", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/updateVerizonInventory" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getVerizonInventory20", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/sendMessage/{message}" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "sendSimpleMessageToSlack20", "parameters" : [ { "name" : "message", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/repairReturnsReport" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getRepairReturnsReport20", "parameters" : [ { "name" : "startDate", "in" : "query", "required" : false, "schema" : { "type" : "string", "format" : "date" } }, { "name" : "endDate", "in" : "query", "required" : false, "schema" : { "type" : "string", "format" : "date" } }, { "name" : "districtId", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "mode", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/assetmanager/2.0/homeAssets" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getHomeAsset20", "parameters" : [ { "name" : "emp_id", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskResponseEntityObject" } } } } } } }, "/assetmanager/2.0/getVerizonOrderInfoRequestObject" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getVerizonOrderInfoRequestObject20", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonOrderInfoRequest" } } } } } } }, "/assetmanager/2.0/getVerizonLookupRequestObject" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getVerizonLookupRequestObject20", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonLookupRequest" } } } } } } }, "/assetmanager/2.0/datasourceConnections" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getConnections_4", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/2.0/autoAssignmentsByDate" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getAutoAssignmentsByDate", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/assetmanager/2.0/assetFind" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "assetFind20", "parameters" : [ { "name" : "serialNumber", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "usicTag", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "referenceId", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetResponse" } } } } } } } }, "/assetmanager/2.0/allAssets" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getAllAssets20", "parameters" : [ { "name" : "emp_id", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/2.0/allAssetsSheet" : { "get" : { "tags" : [ "asset-manager-controller-20" ], "operationId" : "getAllAssetsSheet20", "parameters" : [ { "name" : "emp_id", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/assetmanager/1.0/verizonCheckStatus" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "verizonCheckStatusRequest", "parameters" : [ { "name" : "refNumber", "in" : "query", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonStatusResponse" } } } } } } }, "/assetmanager/1.0/verizonAuthenticationTest" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "verizonAuthenticationTest", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/verifyEquipment" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "verifyEquipment", "parameters" : [ { "name" : "employeeId", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "pickDate", "in" : "query", "required" : false, "schema" : { "type" : "string", "format" : "date" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/1.0/updateVerizonUsage" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getVerizonUsageFile", "parameters" : [ { "name" : "usageType", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/updateVerizonInventory" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getVerizonInventory", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/sendMessage/{message}" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "sendSimpleMessageToSlack", "parameters" : [ { "name" : "message", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/repairReturnsReport" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getRepairReturnsReport", "parameters" : [ { "name" : "startDate", "in" : "query", "required" : false, "schema" : { "type" : "string", "format" : "date" } }, { "name" : "endDate", "in" : "query", "required" : false, "schema" : { "type" : "string", "format" : "date" } }, { "name" : "districtId", "in" : "query", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "mode", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/assetmanager/1.0/homeAssets" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getHomeAsset", "parameters" : [ { "name" : "emp_id", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAsyncTaskResponseEntityObject" } } } } } } }, "/assetmanager/1.0/getVerizonOrderInfoRequestObject" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getVerizonOrderInfoRequestObject", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonOrderInfoRequest" } } } } } } }, "/assetmanager/1.0/getVerizonLookupRequestObject" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getVerizonLookupRequestObject", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VerizonLookupRequest" } } } } } } }, "/assetmanager/1.0/datasourceConnections" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getConnections_5", "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string" } } } } } } }, "/assetmanager/1.0/autoAssignmentsByDate" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getAutoAssignmentsByDate_1", "parameters" : [ { "name" : "Authorization", "in" : "header", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } } } } } }, "/assetmanager/1.0/assetFind" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "assetFind", "parameters" : [ { "name" : "serialNumber", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "usicTag", "in" : "query", "required" : false, "schema" : { "type" : "string" } }, { "name" : "referenceId", "in" : "query", "required" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetResponse" } } } } } } } }, "/assetmanager/1.0/allAssets" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getAllAssets", "parameters" : [ { "name" : "emp_id", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "object" } } } } } } }, "/assetmanager/1.0/allAssetsSheet" : { "get" : { "tags" : [ "asset-manager-controller" ], "operationId" : "getAllAssetsSheet", "parameters" : [ { "name" : "emp_id", "in" : "query", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK", "content" : { "*/*" : { "schema" : { "type" : "string", "format" : "binary" } } } } } } }, "/messaging/2.0/employeeMessages/{id}" : { "delete" : { "tags" : [ "employee-message-controller-20" ], "operationId" : "clear", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/customerportal/2.0/users/{id}" : { "delete" : { "tags" : [ "customer-portal-user-controller-20" ], "operationId" : "delete_2", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } }, "/assetmanager/2.0/attributeMappings/{id}" : { "delete" : { "tags" : [ "attribute-mapping-controller-20" ], "operationId" : "delete_3", "parameters" : [ { "name" : "id", "in" : "path", "required" : true, "schema" : { "type" : "integer", "format" : "int64" } } ], "responses" : { "200" : { "description" : "OK" } } } } }, "components" : { "schemas" : { "ApiError" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "a unique identifier for this particular occurrence of the problem", "exampleSetFlag" : false, "types" : [ "string" ] }, "links" : { "type" : "object", "properties" : { "about" : { "type" : "string", "description" : "a link that leads to further details about this particular occurrence of the problem", "exampleSetFlag" : false, "types" : [ "string" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "status" : { "type" : "string", "description" : "the HTTP status code applicable to this problem, expressed as a string value", "exampleSetFlag" : false, "types" : [ "string" ] }, "code" : { "type" : "string", "description" : "an application-specific error code, expressed as a string value", "exampleSetFlag" : false, "types" : [ "string" ] }, "title" : { "type" : "string", "description" : "a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization", "exampleSetFlag" : false, "types" : [ "string" ] }, "detail" : { "type" : "string", "description" : "a human-readable explanation specific to this occurrence of the problem. Like 'title', this field’s value can be localized.", "exampleSetFlag" : false, "types" : [ "string" ] }, "source" : { "type" : "object", "properties" : { "pointer" : { "type" : "string", "description" : "a JSON Pointer [RFC6901] to the associated entity in the request document", "exampleSetFlag" : false, "types" : [ "string" ] }, "parameter" : { "type" : "string", "description" : "a string indicating which URI query parameter caused the error", "exampleSetFlag" : false, "types" : [ "string" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "meta" : { "$ref" : "#/components/schemas/Meta", "exampleSetFlag" : false } }, "additionalProperties" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "Failure" : { "required" : [ "errors" ], "type" : "object", "properties" : { "jsonapi" : { "$ref" : "#/components/schemas/JsonApi", "exampleSetFlag" : false }, "errors" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApiError", "exampleSetFlag" : false }, "types" : [ "array" ] }, "meta" : { "$ref" : "#/components/schemas/Meta", "exampleSetFlag" : false }, "links" : { "$ref" : "#/components/schemas/Links", "exampleSetFlag" : false } }, "additionalProperties" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "Info" : { "required" : [ "meta" ], "type" : "object", "properties" : { "jsonapi" : { "$ref" : "#/components/schemas/JsonApi", "exampleSetFlag" : false }, "meta" : { "$ref" : "#/components/schemas/Meta", "exampleSetFlag" : false }, "links" : { "$ref" : "#/components/schemas/Links", "exampleSetFlag" : false } }, "additionalProperties" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "JsonApi" : { "type" : "object", "properties" : { "version" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, "additionalProperties" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "Link" : { "description" : "A link **MUST** be represented as either: a string containing the link's URL or a link object.", "exampleSetFlag" : false, "oneOf" : [ { "type" : "string", "description" : "A string containing the link's URL.", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ] }, { "required" : [ "href" ], "type" : "object", "properties" : { "href" : { "type" : "string", "description" : "A string containing the link's URL.", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ] }, "meta" : { "$ref" : "#/components/schemas/Meta", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } ] }, "Links" : { "description" : "Link members related to the primary data.", "exampleSetFlag" : false, "allOf" : [ { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] }, { "$ref" : "#/components/schemas/Pagination", "exampleSetFlag" : false } ] }, "Meta" : { "type" : "object", "additionalProperties" : true, "description" : "Non-standard meta-information that can not be represented as an attribute or relationship.", "exampleSetFlag" : false, "types" : [ "object" ] }, "Pagination" : { "type" : "object", "properties" : { "first" : { "type" : "string", "description" : "The first page of data", "format" : "uri", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "last" : { "type" : "string", "description" : "The last page of data", "format" : "uri", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "prev" : { "type" : "string", "description" : "The previous page of data", "format" : "uri", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "next" : { "type" : "string", "description" : "The next page of data", "format" : "uri", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "Success" : { "required" : [ "data" ], "type" : "object", "properties" : { "jsonapi" : { "$ref" : "#/components/schemas/JsonApi", "exampleSetFlag" : false }, "included" : { "uniqueItems" : true, "type" : "array", "description" : "Included resources", "exampleSetFlag" : false, "items" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type", "exampleSetFlag" : false, "types" : [ "string" ] }, "id" : { "type" : "string", "description" : "The JSON:API resource ID", "exampleSetFlag" : false, "types" : [ "string" ] }, "attributes" : { "type" : "object", "additionalProperties" : true, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "types" : [ "array" ] }, "meta" : { "$ref" : "#/components/schemas/Meta", "exampleSetFlag" : false }, "links" : { "$ref" : "#/components/schemas/Links", "exampleSetFlag" : false } }, "description" : "A JSON:API document with a single resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesAttributes3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualSummariesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AccrualSummariesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AccrualSummariesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualSummariesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualSummariesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualSummariesResourceLinks", "exampleSetFlag" : false } ] }, "AccrualSummariesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualSummariesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesRequest_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualSummariesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (accrualSummaries)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "accrualSummaries" ] }, "id" : { "$ref" : "#/components/schemas/AccrualSummariesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesAccrual_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualSummariesPeriod_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AccrualSummariesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "accrual_type" : { "$ref" : "#/components/schemas/AccrualSummariesAccrual_typeResourceAttribute", "exampleSetFlag" : false }, "ending_balance" : { "$ref" : "#/components/schemas/AccrualSummariesEnding_balanceResourceAttribute", "exampleSetFlag" : false }, "beginning_balance" : { "$ref" : "#/components/schemas/AccrualSummariesBeginning_balanceResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AccrualSummariesCreated_byResourceAttribute", "exampleSetFlag" : false }, "current_flag" : { "$ref" : "#/components/schemas/AccrualSummariesCurrent_flagResourceAttribute", "exampleSetFlag" : false }, "period_amount" : { "$ref" : "#/components/schemas/AccrualSummariesPeriod_amountResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AccrualSummariesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AccrualSummariesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/AccrualSummariesAttributes3ResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/AccrualSummariesPeriod_idResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/AccrualSummariesAttributes2ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/AccrualSummariesRequest_idResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/AccrualSummariesAttributes1ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "accrual_type" : { "$ref" : "#/components/schemas/AccrualSummariesAccrual_typeResourceAttribute", "exampleSetFlag" : false }, "ending_balance" : { "$ref" : "#/components/schemas/AccrualSummariesEnding_balanceResourceAttribute", "exampleSetFlag" : false }, "beginning_balance" : { "$ref" : "#/components/schemas/AccrualSummariesBeginning_balanceResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AccrualSummariesCreated_byResourceAttribute", "exampleSetFlag" : false }, "current_flag" : { "$ref" : "#/components/schemas/AccrualSummariesCurrent_flagResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AccrualSummariesCreated_onResourceAttribute", "exampleSetFlag" : false }, "period_amount" : { "$ref" : "#/components/schemas/AccrualSummariesPeriod_amountResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AccrualSummariesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AccrualSummariesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/AccrualSummariesAttributes3ResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/AccrualSummariesPeriod_idResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/AccrualSummariesAttributes2ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/AccrualSummariesRequest_idResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/AccrualSummariesAttributes1ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesFinancialPeriodResourceAttribute" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AccrualSummariesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualSummariesDistrictResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AccrualSummariesAttributes2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualSummariesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualSummariesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AccrualSummariesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accrualSummaries/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesCurrent_flagResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AccrualSummariesCmsRequestResourceAttribute" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AccrualSummariesEnding_balanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AccrualSummariesAttributes1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualSummariesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualSummariesBeginning_balanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AccrualSummariesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (accrualSummaries)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "accrualSummaries" ] }, "id" : { "$ref" : "#/components/schemas/AccrualSummariesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "current_flag" : { "$ref" : "#/components/schemas/AccrualSummariesCurrent_flagResourceAttribute", "exampleSetFlag" : false }, "accrual_type" : { "$ref" : "#/components/schemas/AccrualSummariesAccrual_typeResourceAttribute", "exampleSetFlag" : false }, "ending_balance" : { "$ref" : "#/components/schemas/AccrualSummariesEnding_balanceResourceAttribute", "exampleSetFlag" : false }, "period_amount" : { "$ref" : "#/components/schemas/AccrualSummariesPeriod_amountResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AccrualSummariesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "beginning_balance" : { "$ref" : "#/components/schemas/AccrualSummariesBeginning_balanceResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/AccrualSummariesAttributes3ResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/AccrualSummariesPeriod_idResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/AccrualSummariesAttributes2ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/AccrualSummariesRequest_idResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/AccrualSummariesAttributes1ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AccrualSummariesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualSummariesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AccrualSummariesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AccrualSummariesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualSummariesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AccrualSummariesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "financialPeriod" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accrualSummaries/{id}/relationships/financialPeriod" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accrualSummaries/{id}/financialPeriod" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "district" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accrualSummaries/{id}/relationships/district" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accrualSummaries/{id}/district" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsRequest" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accrualSummaries/{id}/relationships/cmsRequest" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accrualSummaries/{id}/cmsRequest" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualSummariesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualSummariesPeriod_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualSummariesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AccrualSummariesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AccrualsRemarksResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualsRetain_balanceResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AccrualsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualsAttributes1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AccrualsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsAccrual_source_id2ResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualsCmsRequestResourceAttribute" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AccrualsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "amount" : { "$ref" : "#/components/schemas/AccrualsAmountResourceAttribute", "exampleSetFlag" : false }, "source_accrual_balance" : { "$ref" : "#/components/schemas/AccrualsSource_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "accrual_type" : { "$ref" : "#/components/schemas/AccrualsAccrual_typeResourceAttribute", "exampleSetFlag" : false }, "accrual_source_id3" : { "$ref" : "#/components/schemas/AccrualsAccrual_source_id3ResourceAttribute", "exampleSetFlag" : false }, "accrual_source_id1" : { "$ref" : "#/components/schemas/AccrualsAccrual_source_id1ResourceAttribute", "exampleSetFlag" : false }, "accrual_source_id2" : { "$ref" : "#/components/schemas/AccrualsAccrual_source_id2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AccrualsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AccrualsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AccrualsCreated_onResourceAttribute", "exampleSetFlag" : false }, "accrual_source" : { "$ref" : "#/components/schemas/AccrualsAccrual_sourceResourceAttribute", "exampleSetFlag" : false }, "variance_amount" : { "$ref" : "#/components/schemas/AccrualsVariance_amountResourceAttribute", "exampleSetFlag" : false }, "retain_balance" : { "$ref" : "#/components/schemas/AccrualsRetain_balanceResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AccrualsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AccrualsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/AccrualsAttributes3ResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/AccrualsPeriod_idResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/AccrualsAttributes2ResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/AccrualsAttributes1ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/AccrualsRequest_idResourceAttribute", "exampleSetFlag" : false }, "remarks" : { "$ref" : "#/components/schemas/AccrualsRemarksResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualsResourceLinks", "exampleSetFlag" : false } ] }, "AccrualsAttributes2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (accruals)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "accruals" ] }, "id" : { "$ref" : "#/components/schemas/AccrualsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualsDistrictResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AccrualsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AccrualsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (accruals)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "accruals" ] }, "id" : { "$ref" : "#/components/schemas/AccrualsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsAmountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AccrualsFinancialPeriodResourceAttribute" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AccrualsAccrual_sourceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualsAccrual_source_id1ResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualsAttributes3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AccrualsVariance_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AccrualsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AccrualsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualsResourcePostAttributes", "exampleSetFlag" : false } ] }, "AccrualsRequest_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "amount" : { "$ref" : "#/components/schemas/AccrualsAmountResourceAttribute", "exampleSetFlag" : false }, "source_accrual_balance" : { "$ref" : "#/components/schemas/AccrualsSource_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "accrual_type" : { "$ref" : "#/components/schemas/AccrualsAccrual_typeResourceAttribute", "exampleSetFlag" : false }, "accrual_source_id3" : { "$ref" : "#/components/schemas/AccrualsAccrual_source_id3ResourceAttribute", "exampleSetFlag" : false }, "accrual_source_id1" : { "$ref" : "#/components/schemas/AccrualsAccrual_source_id1ResourceAttribute", "exampleSetFlag" : false }, "accrual_source_id2" : { "$ref" : "#/components/schemas/AccrualsAccrual_source_id2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AccrualsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AccrualsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "accrual_source" : { "$ref" : "#/components/schemas/AccrualsAccrual_sourceResourceAttribute", "exampleSetFlag" : false }, "variance_amount" : { "$ref" : "#/components/schemas/AccrualsVariance_amountResourceAttribute", "exampleSetFlag" : false }, "retain_balance" : { "$ref" : "#/components/schemas/AccrualsRetain_balanceResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AccrualsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AccrualsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/AccrualsAttributes3ResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/AccrualsPeriod_idResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/AccrualsAttributes2ResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/AccrualsAttributes1ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/AccrualsRequest_idResourceAttribute", "exampleSetFlag" : false }, "remarks" : { "$ref" : "#/components/schemas/AccrualsRemarksResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsPeriod_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "financialPeriod" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accruals/{id}/relationships/financialPeriod" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accruals/{id}/financialPeriod" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "district" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accruals/{id}/relationships/district" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accruals/{id}/district" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsRequest" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accruals/{id}/relationships/cmsRequest" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accruals/{id}/cmsRequest" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AccrualsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsSource_accrual_balanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AccrualsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/accruals/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AccrualsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AccrualsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AccrualsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AccrualsAccrual_source_id3ResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AccrualsAccrual_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AccrualsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "amount" : { "$ref" : "#/components/schemas/AccrualsAmountResourceAttribute", "exampleSetFlag" : false }, "source_accrual_balance" : { "$ref" : "#/components/schemas/AccrualsSource_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "accrual_type" : { "$ref" : "#/components/schemas/AccrualsAccrual_typeResourceAttribute", "exampleSetFlag" : false }, "accrual_source_id3" : { "$ref" : "#/components/schemas/AccrualsAccrual_source_id3ResourceAttribute", "exampleSetFlag" : false }, "accrual_source_id1" : { "$ref" : "#/components/schemas/AccrualsAccrual_source_id1ResourceAttribute", "exampleSetFlag" : false }, "accrual_source_id2" : { "$ref" : "#/components/schemas/AccrualsAccrual_source_id2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AccrualsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AccrualsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "accrual_source" : { "$ref" : "#/components/schemas/AccrualsAccrual_sourceResourceAttribute", "exampleSetFlag" : false }, "variance_amount" : { "$ref" : "#/components/schemas/AccrualsVariance_amountResourceAttribute", "exampleSetFlag" : false }, "retain_balance" : { "$ref" : "#/components/schemas/AccrualsRetain_balanceResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AccrualsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AccrualsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/AccrualsAttributes3ResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/AccrualsPeriod_idResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/AccrualsAttributes2ResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/AccrualsAttributes1ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/AccrualsRequest_idResourceAttribute", "exampleSetFlag" : false }, "remarks" : { "$ref" : "#/components/schemas/AccrualsRemarksResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesExport_statusResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivitiesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesStatusCodeResourceAttribute" : { "$ref" : "#/components/schemas/StatusesCodeResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ActivitiesRelevantResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ActivitiesVisit_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivitiesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ActivitiesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ActivitiesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ActivitiesResourceLinks", "exampleSetFlag" : false } ] }, "ActivitiesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ActivitiesAddresses_countResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivitiesWire_centerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ActivitiesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesFeet_locatedResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivitiesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ActivitiesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "firstClosingLocate" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/relationships/firstClosingLocate" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/firstClosingLocate" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locate" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/relationships/locate" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/locate" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locateClosedSnapshot" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/relationships/locateClosedSnapshot" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/locateClosedSnapshot" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "responseLogs" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/relationships/responseLogs" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/responseLogs" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locateOpenSnapshot" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/relationships/locateOpenSnapshot" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/locateOpenSnapshot" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "activityPathPoints" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/relationships/activityPathPoints" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/activityPathPoints" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "visit" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/relationships/visit" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/visit" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "statusCode" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/relationships/statusCode" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}/statusCode" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesCodeResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StatusesCodeResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesLocateOpenSnapshotResourceAttribute" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ActivitiesLocateResourceAttribute" : { "$ref" : "#/components/schemas/LocatesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ActivitiesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (activities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "activities" ] }, "id" : { "$ref" : "#/components/schemas/ActivitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesStatus_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivitiesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ActivitiesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ActivitiesVisitResourceAttribute" : { "$ref" : "#/components/schemas/VisitsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ActivitiesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivitiesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (activities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "activities" ] }, "id" : { "$ref" : "#/components/schemas/ActivitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesResponseLogsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ActivitiesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activities/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ActivitiesPostResourceReference", "exampleSetFlag" : false } ] }, "ActivitiesHours_workedResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ActivitiesLocateClosedSnapshotResourceAttribute" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ActivitiesActivityPathPointsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ActivitiesClosing_overrideResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ActivitiesLocate_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivitiesHigh_profile_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivitiesFirstClosingLocateResourceAttribute" : { "$ref" : "#/components/schemas/LocatesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ActivitiesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "export_status" : { "$ref" : "#/components/schemas/ActivitiesExport_statusResourceAttribute", "exampleSetFlag" : false }, "locate_id" : { "$ref" : "#/components/schemas/ActivitiesLocate_idResourceAttribute", "exampleSetFlag" : false }, "high_profile_id" : { "$ref" : "#/components/schemas/ActivitiesHigh_profile_idResourceAttribute", "exampleSetFlag" : false }, "wire_center" : { "$ref" : "#/components/schemas/ActivitiesWire_centerResourceAttribute", "exampleSetFlag" : false }, "relevant" : { "$ref" : "#/components/schemas/ActivitiesRelevantResourceAttribute", "exampleSetFlag" : false }, "billed" : { "$ref" : "#/components/schemas/ActivitiesBilledResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/ActivitiesStatus_idResourceAttribute", "exampleSetFlag" : false }, "feet_located" : { "$ref" : "#/components/schemas/ActivitiesFeet_locatedResourceAttribute", "exampleSetFlag" : false }, "hours_worked" : { "$ref" : "#/components/schemas/ActivitiesHours_workedResourceAttribute", "exampleSetFlag" : false }, "visit_id" : { "$ref" : "#/components/schemas/ActivitiesVisit_idResourceAttribute", "exampleSetFlag" : false }, "closing_override" : { "$ref" : "#/components/schemas/ActivitiesClosing_overrideResourceAttribute", "exampleSetFlag" : false }, "billable_override" : { "$ref" : "#/components/schemas/ActivitiesBillable_overrideResourceAttribute", "exampleSetFlag" : false }, "addresses_count" : { "$ref" : "#/components/schemas/ActivitiesAddresses_countResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivitiesBillable_overrideResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ActivitiesBilledResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ActivityPathPointsTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ActivityPathPointsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "survey_id" : { "$ref" : "#/components/schemas/ActivityPathPointsSurvey_idResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/ActivityPathPointsActivity_idResourceAttribute", "exampleSetFlag" : false }, "when_captured" : { "$ref" : "#/components/schemas/ActivityPathPointsWhen_capturedResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/ActivityPathPointsLonResourceAttribute", "exampleSetFlag" : false }, "source" : { "$ref" : "#/components/schemas/ActivityPathPointsSourceResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/ActivityPathPointsTicket_idResourceAttribute", "exampleSetFlag" : false }, "order_index" : { "$ref" : "#/components/schemas/ActivityPathPointsOrder_indexResourceAttribute", "exampleSetFlag" : false }, "group_index" : { "$ref" : "#/components/schemas/ActivityPathPointsGroup_indexResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/ActivityPathPointsLatResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsWhen_capturedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ActivityPathPointsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "survey_id" : { "$ref" : "#/components/schemas/ActivityPathPointsSurvey_idResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/ActivityPathPointsActivity_idResourceAttribute", "exampleSetFlag" : false }, "when_captured" : { "$ref" : "#/components/schemas/ActivityPathPointsWhen_capturedResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/ActivityPathPointsLonResourceAttribute", "exampleSetFlag" : false }, "source" : { "$ref" : "#/components/schemas/ActivityPathPointsSourceResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/ActivityPathPointsTicket_idResourceAttribute", "exampleSetFlag" : false }, "order_index" : { "$ref" : "#/components/schemas/ActivityPathPointsOrder_indexResourceAttribute", "exampleSetFlag" : false }, "group_index" : { "$ref" : "#/components/schemas/ActivityPathPointsGroup_indexResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/ActivityPathPointsLatResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ActivityPathPointsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ActivityPathPointsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ActivityPathPointsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ActivityPathPointsResourcePostAttributes", "exampleSetFlag" : false } ] }, "ActivityPathPointsSourceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ActivityPathPointsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivityPathPointsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activityPathPoints/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsOrder_indexResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivityPathPointsGroup_indexResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivityPathPointsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivityPathPointsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivityPathPointsLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ActivityPathPointsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ActivityPathPointsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (activityPathPoints)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "activityPathPoints" ] }, "id" : { "$ref" : "#/components/schemas/ActivityPathPointsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ActivityPathPointsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ActivityPathPointsActivityResourceAttribute" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ActivityPathPointsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (activityPathPoints)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "activityPathPoints" ] }, "id" : { "$ref" : "#/components/schemas/ActivityPathPointsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsActivity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivityPathPointsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "survey_id" : { "$ref" : "#/components/schemas/ActivityPathPointsSurvey_idResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/ActivityPathPointsActivity_idResourceAttribute", "exampleSetFlag" : false }, "when_captured" : { "$ref" : "#/components/schemas/ActivityPathPointsWhen_capturedResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/ActivityPathPointsLonResourceAttribute", "exampleSetFlag" : false }, "source" : { "$ref" : "#/components/schemas/ActivityPathPointsSourceResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/ActivityPathPointsTicket_idResourceAttribute", "exampleSetFlag" : false }, "order_index" : { "$ref" : "#/components/schemas/ActivityPathPointsOrder_indexResourceAttribute", "exampleSetFlag" : false }, "group_index" : { "$ref" : "#/components/schemas/ActivityPathPointsGroup_indexResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/ActivityPathPointsLatResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsSurvey_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ActivityPathPointsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ActivityPathPointsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ActivityPathPointsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ActivityPathPointsResourceLinks", "exampleSetFlag" : false } ] }, "ActivityPathPointsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ActivityPathPointsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "activity" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activityPathPoints/{id}/relationships/activity" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activityPathPoints/{id}/activity" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activityPathPoints/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/activityPathPoints/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AnnouncementsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AnnouncementsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (announcements)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "announcements" ] }, "id" : { "$ref" : "#/components/schemas/AnnouncementsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AnnouncementsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AnnouncementsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AnnouncementsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AnnouncementsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AnnouncementsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AnnouncementsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "announcement_text" : { "$ref" : "#/components/schemas/AnnouncementsAnnouncement_textResourceAttribute", "exampleSetFlag" : false }, "high_priority" : { "$ref" : "#/components/schemas/AnnouncementsHigh_priorityResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AnnouncementsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AnnouncementsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AnnouncementsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AnnouncementsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AnnouncementsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AnnouncementsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AnnouncementsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "announcement_text" : { "$ref" : "#/components/schemas/AnnouncementsAnnouncement_textResourceAttribute", "exampleSetFlag" : false }, "high_priority" : { "$ref" : "#/components/schemas/AnnouncementsHigh_priorityResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AnnouncementsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AnnouncementsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AnnouncementsAnnouncement_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AnnouncementsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AnnouncementsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AnnouncementsEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AnnouncementsHigh_priorityResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AnnouncementsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (announcements)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "announcements" ] }, "id" : { "$ref" : "#/components/schemas/AnnouncementsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AnnouncementsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AnnouncementsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AnnouncementsResourcePostAttributes", "exampleSetFlag" : false } ] }, "AnnouncementsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AnnouncementsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AnnouncementsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AnnouncementsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AnnouncementsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AnnouncementsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AnnouncementsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "announcement_text" : { "$ref" : "#/components/schemas/AnnouncementsAnnouncement_textResourceAttribute", "exampleSetFlag" : false }, "high_priority" : { "$ref" : "#/components/schemas/AnnouncementsHigh_priorityResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AnnouncementsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/announcements/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/announcements/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/announcements/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AnnouncementsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AnnouncementsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AnnouncementsResourceLinks", "exampleSetFlag" : false } ] }, "AnnouncementsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AnnouncementsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AnnouncementsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ApplicationsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsUserDataAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ApplicationsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ApplicationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ApplicationsNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ApplicationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ApplicationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "url" : { "$ref" : "#/components/schemas/ApplicationsUrlResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ApplicationsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsAttachmentEntitiesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ApplicationsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ApplicationsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ApplicationsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApplicationsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApplicationsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsUrlResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ApplicationsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "storageVolumes" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/applications/{id}/relationships/storageVolumes" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/applications/{id}/storageVolumes" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentEntities" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/applications/{id}/relationships/attachmentEntities" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/applications/{id}/attachmentEntities" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userDataAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/applications/{id}/relationships/userDataAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/applications/{id}/userDataAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ApplicationsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/applications/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsStorageVolumesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ApplicationsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (applications)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "applications" ] }, "id" : { "$ref" : "#/components/schemas/ApplicationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ApplicationsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ApplicationsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ApplicationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ApplicationsNameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ApplicationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "url" : { "$ref" : "#/components/schemas/ApplicationsUrlResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ApplicationsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApplicationsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApplicationsResourcePostRelationships", "exampleSetFlag" : false } ] }, "ApplicationsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (applications)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "applications" ] }, "id" : { "$ref" : "#/components/schemas/ApplicationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ApplicationsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApplicationsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApplicationsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApplicationsResourceLinks", "exampleSetFlag" : false } ] }, "ApplicationsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "userDataAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ApplicationsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ApplicationsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ApplicationsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ApplicationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ApplicationsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ApplicationsNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ApplicationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ApplicationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "url" : { "$ref" : "#/components/schemas/ApplicationsUrlResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "userDataAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApplicationsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ApproverListingsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApproverListingsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApproverListingsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApproverListingsResourceLinks", "exampleSetFlag" : false } ] }, "ApproverListingsDistrictResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ApproverListingsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "district" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/approverListings/{id}/relationships/district" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/approverListings/{id}/district" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/approverListings/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/approverListings/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ApproverListingsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ApproverListingsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ApproverListingsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/ApproverListingsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "amount" : { "$ref" : "#/components/schemas/ApproverListingsAmountResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ApproverListingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "activity" : { "$ref" : "#/components/schemas/ApproverListingsActivityResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ApproverListingsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/ApproverListingsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ApproverListingsCreated_byResourceAttribute", "exampleSetFlag" : false }, "job_title" : { "$ref" : "#/components/schemas/ApproverListingsJob_titleResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/ApproverListingsEmp_idResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/ApproverListingsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsJob_titleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ApproverListingsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/approverListings/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ApproverListingsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsAmountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ApproverListingsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/ApproverListingsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "amount" : { "$ref" : "#/components/schemas/ApproverListingsAmountResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ApproverListingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "activity" : { "$ref" : "#/components/schemas/ApproverListingsActivityResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/ApproverListingsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ApproverListingsCreated_byResourceAttribute", "exampleSetFlag" : false }, "job_title" : { "$ref" : "#/components/schemas/ApproverListingsJob_titleResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/ApproverListingsEmp_idResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/ApproverListingsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsActivityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ApproverListingsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ApproverListingsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ApproverListingsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/ApproverListingsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "amount" : { "$ref" : "#/components/schemas/ApproverListingsAmountResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ApproverListingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "activity" : { "$ref" : "#/components/schemas/ApproverListingsActivityResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ApproverListingsCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ApproverListingsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/ApproverListingsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ApproverListingsCreated_byResourceAttribute", "exampleSetFlag" : false }, "job_title" : { "$ref" : "#/components/schemas/ApproverListingsJob_titleResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/ApproverListingsEmp_idResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/ApproverListingsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApproverListingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ApproverListingsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ApproverListingsStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ApproverListingsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (approverListings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "approverListings" ] }, "id" : { "$ref" : "#/components/schemas/ApproverListingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ApproverListingsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApproverListingsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ApproverListingsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ApproverListingsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApproverListingsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ApproverListingsEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ApproverListingsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (approverListings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "approverListings" ] }, "id" : { "$ref" : "#/components/schemas/ApproverListingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ApproverListingsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ApproverListingsEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ApproverListingsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ApproverListingsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ApproverListingsResourcePostAttributes", "exampleSetFlag" : false } ] }, "ApproverListingsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApproverListingsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAssignmentsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAssignmentsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAssignmentsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAssignmentsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetAssignmentsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetAssignments)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetAssignments" ] }, "id" : { "$ref" : "#/components/schemas/AssetAssignmentsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAssignmentsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetAssignmentsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAssignmentsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAssignmentsResourcePostRelationships", "exampleSetFlag" : false } ] }, "AssetAssignmentsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetAssignmentsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetAssignmentsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsEmployeesActiveMultipleItAssetsResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetAssignmentsNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAssignmentsAsset_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetAssignmentsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAssignmentsAssigned_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetAssignmentsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAssignmentsAssignedByEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetAssignmentsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetAssignmentsActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AssetAssignmentsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetAssignmentsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "assigned_on" : { "$ref" : "#/components/schemas/AssetAssignmentsAssigned_onResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetAssignmentsNotesResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/AssetAssignmentsActiveResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/AssetAssignmentsAsset_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetAssignmentsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetAssignmentsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetAssignmentsCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AssetAssignmentsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetAssignmentsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "primary_flag" : { "$ref" : "#/components/schemas/AssetAssignmentsPrimary_flagResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetAssignmentsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "assigned_by" : { "$ref" : "#/components/schemas/AssetAssignmentsAssigned_byResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetAssignmentsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "assigned_on" : { "$ref" : "#/components/schemas/AssetAssignmentsAssigned_onResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetAssignmentsNotesResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/AssetAssignmentsActiveResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/AssetAssignmentsAsset_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetAssignmentsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetAssignmentsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AssetAssignmentsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetAssignmentsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "primary_flag" : { "$ref" : "#/components/schemas/AssetAssignmentsPrimary_flagResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetAssignmentsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "assigned_by" : { "$ref" : "#/components/schemas/AssetAssignmentsAssigned_byResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetAssignmentsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetAssignmentsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "assigned_on" : { "$ref" : "#/components/schemas/AssetAssignmentsAssigned_onResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetAssignmentsNotesResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/AssetAssignmentsActiveResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/AssetAssignmentsAsset_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetAssignmentsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetAssignmentsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AssetAssignmentsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetAssignmentsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "primary_flag" : { "$ref" : "#/components/schemas/AssetAssignmentsPrimary_flagResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "assigned_by" : { "$ref" : "#/components/schemas/AssetAssignmentsAssigned_byResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetAssignmentsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetAssignmentsEmployeeOnLoanResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetAssignmentsAssetResourceAttribute" : { "$ref" : "#/components/schemas/AssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetAssignmentsEmployeesActiveNoAssetResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetAssignmentsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeeOnLoan" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assignedByEmployee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAssignmentsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetAssignments)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetAssignments" ] }, "id" : { "$ref" : "#/components/schemas/AssetAssignmentsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAssignmentsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAssignmentsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAssignmentsResourceLinks", "exampleSetFlag" : false } ] }, "AssetAssignmentsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeeOnLoan" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assignedByEmployee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeesActiveNoAsset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/relationships/employeesActiveNoAsset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/employeesActiveNoAsset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeeOnLoan" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/relationships/employeeOnLoan" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/employeeOnLoan" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assignedByEmployee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/relationships/assignedByEmployee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/assignedByEmployee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesActiveMultipleItAssets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/relationships/employeesActiveMultipleItAssets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/employeesActiveMultipleItAssets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/relationships/asset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAssignments/{id}/asset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAssignmentsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetAssignmentsEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetAssignmentsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAssignmentsAssigned_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetAssignmentsPrimary_flagResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AssetAssignmentsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetAssignmentsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetAttributeValuesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AssetAttributeValuesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetAttributeValues)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetAttributeValues" ] }, "id" : { "$ref" : "#/components/schemas/AssetAttributeValuesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetAttributeValuesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetAttributeValuesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetAttributeValuesNotesResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/AssetAttributeValuesActiveResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/AssetAttributeValuesAsset_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/AssetAttributeValuesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetAttributeValuesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetAttributeValuesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "record_description" : { "$ref" : "#/components/schemas/AssetAttributeValuesRecord_descriptionResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "attribute_id" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetAttributeValuesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "update_process" : { "$ref" : "#/components/schemas/AssetAttributeValuesUpdate_processResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/AssetAttributeValuesValueResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetAttributeValuesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetAttributeValuesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetAttributeValuesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAttribute" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesAsset_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetAttributeValuesAttribute_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetAttributeValuesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributeValuesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributeValuesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetAttributeValuesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetAttributeValuesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesUpdate_processResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetAttributeValuesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetAttributeValuesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributeValuesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributeValuesResourcePostRelationships", "exampleSetFlag" : false } ] }, "AssetAttributeValuesValueResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAttribute" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAttributeValues/{id}/relationships/assetAttribute" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAttributeValues/{id}/assetAttribute" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetAttributeValuesRecord_descriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetAttributeValuesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetAttributeValuesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetAttributeValuesNotesResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/AssetAttributeValuesActiveResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/AssetAttributeValuesAsset_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/AssetAttributeValuesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetAttributeValuesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetAttributeValuesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "record_description" : { "$ref" : "#/components/schemas/AssetAttributeValuesRecord_descriptionResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetAttributeValuesCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute_id" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetAttributeValuesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "update_process" : { "$ref" : "#/components/schemas/AssetAttributeValuesUpdate_processResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetAttributeValuesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/AssetAttributeValuesValueResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetAttributeValues)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetAttributeValues" ] }, "id" : { "$ref" : "#/components/schemas/AssetAttributeValuesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributeValuesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributeValuesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributeValuesResourceLinks", "exampleSetFlag" : false } ] }, "AssetAttributeValuesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAttributeValues/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAttribute" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetAttributeValuesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetAttributeValuesNotesResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/AssetAttributeValuesActiveResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/AssetAttributeValuesAsset_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/AssetAttributeValuesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetAttributeValuesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetAttributeValuesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "record_description" : { "$ref" : "#/components/schemas/AssetAttributeValuesRecord_descriptionResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "attribute_id" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetAttributeValuesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "update_process" : { "$ref" : "#/components/schemas/AssetAttributeValuesUpdate_processResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetAttributeValuesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetAttributeValuesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/AssetAttributeValuesValueResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributeValuesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributeValuesAssetAttributeResourceAttribute" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "nullable" : false, "exampleSetFlag" : false }, "AssetAttributesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetAttributesAttributeMappingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetAttributesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAttributes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesLabelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetAttributesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetAttributesNotesResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetAttributesDescriptionResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/AssetAttributesLabelResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetAttributesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetAttributesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetAttributesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "required_field" : { "$ref" : "#/components/schemas/AssetAttributesRequired_fieldResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetAttributesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetAttributesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetAttributesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetAttributesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "data_type" : { "$ref" : "#/components/schemas/AssetAttributesData_typeResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetAttributesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetAttributesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetAttributesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetAttributesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "attributeMappings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAttributes/{id}/relationships/attributeMappings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAttributes/{id}/attributeMappings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetAttributeValues" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAttributes/{id}/relationships/assetAttributeValues" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetAttributes/{id}/assetAttributeValues" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetAttributesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesAssetAttributeValuesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetAttributesData_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetAttributesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetAttributesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetAttributesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetAttributesNotesResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetAttributesDescriptionResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/AssetAttributesLabelResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetAttributesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetAttributesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetAttributesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "required_field" : { "$ref" : "#/components/schemas/AssetAttributesRequired_fieldResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetAttributesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetAttributesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetAttributesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "data_type" : { "$ref" : "#/components/schemas/AssetAttributesData_typeResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetAttributesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetAttributesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetAttributesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetAttributesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AssetAttributesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetAttributesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetAttributes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetAttributes" ] }, "id" : { "$ref" : "#/components/schemas/AssetAttributesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetAttributesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetAttributesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetAttributesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetAttributesResourceLinks", "exampleSetFlag" : false } ] }, "AssetAttributesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetAttributesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetAttributesRequired_fieldResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AssetAttributesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetAttributesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetAttributesNotesResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetAttributesDescriptionResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/AssetAttributesLabelResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetAttributesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetAttributesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetAttributesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "required_field" : { "$ref" : "#/components/schemas/AssetAttributesRequired_fieldResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetAttributesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetAttributesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetAttributesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "data_type" : { "$ref" : "#/components/schemas/AssetAttributesData_typeResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetAttributesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetAttributesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetAttributesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetAttributesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetAttributes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetAttributes" ] }, "id" : { "$ref" : "#/components/schemas/AssetAttributesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetAttributesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetCategories/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesCategoryTypeMakeMappingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetCategoriesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoriesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetCategoriesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoriesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "categoryTypeMakeMappings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetCategories/{id}/relationships/categoryTypeMakeMappings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetCategories/{id}/categoryTypeMakeMappings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetCategoriesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetCategoriesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetCategoriesDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetCategoriesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetCategoriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetCategoriesCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetCategoriesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetCategoriesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetCategoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetCategoriesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoriesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetCategoriesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetCategoriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetCategoriesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetCategoriesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetCategoriesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetCategoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetCategoriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetCategoriesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetCategories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetCategories" ] }, "id" : { "$ref" : "#/components/schemas/AssetCategoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetCategoriesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetCategoriesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetCategoriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetCategoriesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetCategoriesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetCategoriesDescriptionResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetCategoriesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetCategoriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetCategoriesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoriesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoriesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoriesResourceLinks", "exampleSetFlag" : false } ] }, "AssetCategoriesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetCategoriesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetCategories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetCategories" ] }, "id" : { "$ref" : "#/components/schemas/AssetCategoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoriesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetCategoriesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetCategoriesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoriesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetCategoriesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoriesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AssetCategoryTypesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetCategoryTypesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoryTypesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AssetCategoryTypesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoryTypesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoryTypesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetCategoryTypesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetCategoryTypesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetCategoryTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetCategoryTypesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetCategoryTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetCategoryTypesCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetCategoryTypesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetCategoryTypesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetCategoryTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetCategoryTypesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoryTypesCategoryTypeMakeMappingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetCategoryTypesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoryTypesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetCategoryTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetCategoryTypes" ] }, "id" : { "$ref" : "#/components/schemas/AssetCategoryTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetCategoryTypesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoryTypesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoryTypesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetCategoryTypesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "categoryTypeMakeMappings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetCategoryTypes/{id}/relationships/categoryTypeMakeMappings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetCategoryTypes/{id}/categoryTypeMakeMappings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetCategoryTypesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoryTypesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoryTypesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoryTypesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoryTypesResourceLinks", "exampleSetFlag" : false } ] }, "AssetCategoryTypesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetCategoryTypesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoryTypesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetCategoryTypesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetCategoryTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetCategoryTypesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetCategoryTypesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetCategoryTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetCategoryTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetCategoryTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoryTypesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetCategoryTypesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetCategoryTypes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetCategoryTypesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetCategoryTypesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetCategoryTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetCategoryTypesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetCategoryTypesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetCategoryTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetCategoryTypesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetCategoryTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetCategoryTypesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetCategoryTypesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetCategoryTypesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetCategoryTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetCategoryTypes" ] }, "id" : { "$ref" : "#/components/schemas/AssetCategoryTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetMakesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetMakesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetMakesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetMakesNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetMakesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetMakesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetMakesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetMakesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetMakesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetMakesAssetModelsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetMakesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetMakesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetMakesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetMakesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetMakesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetMakesCategoryTypeMakeMappingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetMakesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetMakesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetMakesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetMakesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetMakesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetMakesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetMakesNotesResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetMakesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetMakesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetMakesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetMakesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetMakesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetMakesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "categoryTypeMakeMappings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetMakes/{id}/relationships/categoryTypeMakeMappings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetMakes/{id}/categoryTypeMakeMappings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attributeMappings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetMakes/{id}/relationships/attributeMappings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetMakes/{id}/attributeMappings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetModels" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetMakes/{id}/relationships/assetModels" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetMakes/{id}/assetModels" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetMakesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetMakes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetMakes" ] }, "id" : { "$ref" : "#/components/schemas/AssetMakesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetMakesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetMakesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetMakesNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetMakesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetMakesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetMakesDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetMakesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetMakesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetMakesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetMakes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetMakes" ] }, "id" : { "$ref" : "#/components/schemas/AssetMakesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetMakesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetMakesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AssetMakesAttributeMappingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetMakesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetMakesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetMakesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetMakesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetMakesResourceLinks", "exampleSetFlag" : false } ] }, "AssetMakesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetMakesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetMakes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetMakesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetModelsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetModelsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetModelsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetModels/{id}/relationships/assets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetModels/{id}/assets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetMake" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetModels/{id}/relationships/assetMake" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetModels/{id}/assetMake" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetModelsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetModelsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetModelsNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetModelsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetModelsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetModelsDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetModelsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "make_id" : { "$ref" : "#/components/schemas/AssetModelsMake_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetModelsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetModelsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetModelsAssetMakeResourceAttribute" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetModelsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetModels)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetModels" ] }, "id" : { "$ref" : "#/components/schemas/AssetModelsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetMake" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetModelsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetModelsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetModelsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetModelsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetModelsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetModels)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetModels" ] }, "id" : { "$ref" : "#/components/schemas/AssetModelsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetModelsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetModelsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetMake" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetModelsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetModelsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetModelsNotesResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetModelsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetModelsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetModelsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetModelsDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetModelsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "make_id" : { "$ref" : "#/components/schemas/AssetModelsMake_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetModelsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetModelsAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetModelsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetModelsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetModelsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetModelsNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetModelsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetModelsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetModelsDescriptionResourceAttribute", "exampleSetFlag" : false }, "make_id" : { "$ref" : "#/components/schemas/AssetModelsMake_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetModelsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetModelsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetModels/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetModelsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsMake_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetModelsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetModelsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetModelsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetModelsResourceLinks", "exampleSetFlag" : false } ] }, "AssetModelsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetModelsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetModelsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetModelsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetModelsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetModelsResourcePostRelationships", "exampleSetFlag" : false } ] }, "AssetStatusesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetStatusesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetStatusesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetStatusesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetStatusesDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetStatusesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetStatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetStatusesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetStatusesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetStatusesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetStatusesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetStatusesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetStatusesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetStatusesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetStatusesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetStatusesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetStatusesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetStatusesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetStatusesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetStatusesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetStatuses/{id}/relationships/assets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetStatuses/{id}/assets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetStatusesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetStatusesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetStatusesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetStatusesResourceLinks", "exampleSetFlag" : false } ] }, "AssetStatusesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetStatusesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetStatusesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetStatusesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetStatusesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetStatuses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetStatuses" ] }, "id" : { "$ref" : "#/components/schemas/AssetStatusesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetStatusesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetStatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetStatusesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetStatusesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetStatusesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetStatusesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetStatusesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetStatusesDescriptionResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetStatusesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetStatusesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetStatusesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetStatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetStatusesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetStatusesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetStatusesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetStatusesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AssetStatusesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetStatusesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetStatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetStatusesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetStatusesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetStatusesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetStatusesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetStatusesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetStatusesDescriptionResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetStatusesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetStatusesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetStatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetStatusesAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetStatusesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetStatusesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetStatusesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetStatusesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetStatuses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetStatuses" ] }, "id" : { "$ref" : "#/components/schemas/AssetStatusesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetStatusesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetStatusesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetStatuses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetStatusesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetStatusesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetTrackMaintenancesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetTrackMaintenances)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetTrackMaintenances" ] }, "id" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesContact_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTrackMaintenancesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetTrackMaintenancesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetTrackMaintenances)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetTrackMaintenances" ] }, "id" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesCalibration_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTrackMaintenancesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesTaskResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTrackMaintenancesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesSerial_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTrackMaintenancesOrganization_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTrackMaintenancesLocation_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTrackMaintenancesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "contact_name" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesContact_nameResourceAttribute", "exampleSetFlag" : false }, "location_name" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesLocation_nameResourceAttribute", "exampleSetFlag" : false }, "calibration_due_date" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesCalibration_due_dateResourceAttribute", "exampleSetFlag" : false }, "task" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesTaskResourceAttribute", "exampleSetFlag" : false }, "asset_type" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesAsset_typeResourceAttribute", "exampleSetFlag" : false }, "tag_number" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesTag_numberResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesSerial_numberResourceAttribute", "exampleSetFlag" : false }, "organization_name" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesOrganization_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesTag_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTrackMaintenancesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTrackMaintenances/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesVersion_numberResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTrackMaintenancesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "contact_name" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesContact_nameResourceAttribute", "exampleSetFlag" : false }, "location_name" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesLocation_nameResourceAttribute", "exampleSetFlag" : false }, "calibration_due_date" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesCalibration_due_dateResourceAttribute", "exampleSetFlag" : false }, "task" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesTaskResourceAttribute", "exampleSetFlag" : false }, "asset_type" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesAsset_typeResourceAttribute", "exampleSetFlag" : false }, "tag_number" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesTag_numberResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesVersion_numberResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesSerial_numberResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesAsset_idResourceAttribute", "exampleSetFlag" : false }, "organization_name" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesOrganization_nameResourceAttribute", "exampleSetFlag" : false }, "asset_status" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesAsset_statusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "asset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTrackMaintenances/{id}/relationships/asset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTrackMaintenances/{id}/asset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceLinks", "exampleSetFlag" : false } ] }, "AssetTrackMaintenancesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetTrackMaintenancesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetTrackMaintenancesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AssetTrackMaintenancesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesAsset_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTrackMaintenancesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "contact_name" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesContact_nameResourceAttribute", "exampleSetFlag" : false }, "location_name" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesLocation_nameResourceAttribute", "exampleSetFlag" : false }, "calibration_due_date" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesCalibration_due_dateResourceAttribute", "exampleSetFlag" : false }, "task" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesTaskResourceAttribute", "exampleSetFlag" : false }, "asset_type" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesAsset_typeResourceAttribute", "exampleSetFlag" : false }, "tag_number" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesTag_numberResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesSerial_numberResourceAttribute", "exampleSetFlag" : false }, "organization_name" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesOrganization_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesAsset_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTrackMaintenancesAssetResourceAttribute" : { "$ref" : "#/components/schemas/AssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetTrackMaintenancesIdResourceAttribute" : { "type" : "object", "properties" : { "asset_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "version_number" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTrackMaintenancesAsset_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsAsset_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsTransferring_cost_centerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetTransferExceptionsPostResourceReference", "exampleSetFlag" : false } ] }, "AssetTransferExceptionsReceiving_cost_centerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsIdResourceAttribute" : { "type" : "object", "properties" : { "asset_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "version_number" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetTransferExceptions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetTransferExceptions" ] }, "id" : { "$ref" : "#/components/schemas/AssetTransferExceptionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsEmployee_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsAsset_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTransferExceptionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTransferExceptions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "asset_district_id" : { "$ref" : "#/components/schemas/AssetTransferExceptionsAsset_district_idResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/AssetTransferExceptionsVersion_numberResourceAttribute", "exampleSetFlag" : false }, "employee_name" : { "$ref" : "#/components/schemas/AssetTransferExceptionsEmployee_nameResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/AssetTransferExceptionsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/AssetTransferExceptionsAsset_idResourceAttribute", "exampleSetFlag" : false }, "transferring_cost_center" : { "$ref" : "#/components/schemas/AssetTransferExceptionsTransferring_cost_centerResourceAttribute", "exampleSetFlag" : false }, "total_days_in_transit" : { "$ref" : "#/components/schemas/AssetTransferExceptionsTotal_days_in_transitResourceAttribute", "exampleSetFlag" : false }, "receiving_supgroup_code" : { "$ref" : "#/components/schemas/AssetTransferExceptionsReceiving_supgroup_codeResourceAttribute", "exampleSetFlag" : false }, "receiving_district_id" : { "$ref" : "#/components/schemas/AssetTransferExceptionsReceiving_district_idResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AssetTransferExceptionsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "asset_type" : { "$ref" : "#/components/schemas/AssetTransferExceptionsAsset_typeResourceAttribute", "exampleSetFlag" : false }, "tag_number" : { "$ref" : "#/components/schemas/AssetTransferExceptionsTag_numberResourceAttribute", "exampleSetFlag" : false }, "receiving_cost_center" : { "$ref" : "#/components/schemas/AssetTransferExceptionsReceiving_cost_centerResourceAttribute", "exampleSetFlag" : false }, "job_title" : { "$ref" : "#/components/schemas/AssetTransferExceptionsJob_titleResourceAttribute", "exampleSetFlag" : false }, "transferring_district_id" : { "$ref" : "#/components/schemas/AssetTransferExceptionsTransferring_district_idResourceAttribute", "exampleSetFlag" : false }, "asset_supgroup_code" : { "$ref" : "#/components/schemas/AssetTransferExceptionsAsset_supgroup_codeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetTransferExceptionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsVersion_numberResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTransferExceptionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "asset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTransferExceptions/{id}/relationships/asset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTransferExceptions/{id}/asset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetTransferExceptions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetTransferExceptions" ] }, "id" : { "$ref" : "#/components/schemas/AssetTransferExceptionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsSerial_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsAssetResourceAttribute" : { "$ref" : "#/components/schemas/AssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetTransferExceptionsTag_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsTransferring_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTransferExceptionsAsset_supgroup_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTransferExceptionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTransferExceptionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceLinks", "exampleSetFlag" : false } ] }, "AssetTransferExceptionsTotal_days_in_transitResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTransferExceptionsAsset_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTransferExceptionsReceiving_supgroup_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsJob_titleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTransferExceptionsEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTransferExceptionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetTransferExceptionsReceiving_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTransferExceptionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetTransferExceptionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetTypesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetTypesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTypesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetTypesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTypesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetTypesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetTypesNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetTypesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetTypesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTypes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetTypesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetTypesNotesResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetTypesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetTypesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetTypesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetTypesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTypesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTypesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "categoryTypeMakeMappings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTypes/{id}/relationships/categoryTypeMakeMappings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTypes/{id}/categoryTypeMakeMappings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attributeMappings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTypes/{id}/relationships/attributeMappings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assetTypes/{id}/attributeMappings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTypesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTypesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTypesResourceLinks", "exampleSetFlag" : false } ] }, "AssetTypesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetTypesNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTypesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTypesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetTypesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetTypesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetTypes" ] }, "id" : { "$ref" : "#/components/schemas/AssetTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetTypesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetTypesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AssetTypesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetTypesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetTypesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTypesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assetTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assetTypes" ] }, "id" : { "$ref" : "#/components/schemas/AssetTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetTypesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetTypesAttributeMappingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetTypesCategoryTypeMakeMappingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetTypesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AssetTypesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AssetTypesNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/AssetTypesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetTypesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsStatus_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsTracking_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsDeletionTypeResourceAttribute" : { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsDeletion_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsAssetAttributeValuesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "notes" : { "$ref" : "#/components/schemas/AssetsNotesResourceAttribute", "exampleSetFlag" : false }, "original_creation_date" : { "$ref" : "#/components/schemas/AssetsOriginal_creation_dateResourceAttribute", "exampleSetFlag" : false }, "reference_id" : { "$ref" : "#/components/schemas/AssetsReference_idResourceAttribute", "exampleSetFlag" : false }, "repair_reason_id" : { "$ref" : "#/components/schemas/AssetsRepair_reason_idResourceAttribute", "exampleSetFlag" : false }, "warranty_end_date" : { "$ref" : "#/components/schemas/AssetsWarranty_end_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetsDescriptionResourceAttribute", "exampleSetFlag" : false }, "location_id" : { "$ref" : "#/components/schemas/AssetsLocation_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/AssetsStatus_idResourceAttribute", "exampleSetFlag" : false }, "warranty" : { "$ref" : "#/components/schemas/AssetsWarrantyResourceAttribute", "exampleSetFlag" : false }, "in_transfer" : { "$ref" : "#/components/schemas/AssetsIn_transferResourceAttribute", "exampleSetFlag" : false }, "police_report_number" : { "$ref" : "#/components/schemas/AssetsPolice_report_numberResourceAttribute", "exampleSetFlag" : false }, "loss_date" : { "$ref" : "#/components/schemas/AssetsLoss_dateResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/AssetsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "warranty_start_date" : { "$ref" : "#/components/schemas/AssetsWarranty_start_dateResourceAttribute", "exampleSetFlag" : false }, "source_system" : { "$ref" : "#/components/schemas/AssetsSource_systemResourceAttribute", "exampleSetFlag" : false }, "loss_address" : { "$ref" : "#/components/schemas/AssetsLoss_addressResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/AssetsActiveResourceAttribute", "exampleSetFlag" : false }, "tax" : { "$ref" : "#/components/schemas/AssetsTaxResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/AssetsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "model_id" : { "$ref" : "#/components/schemas/AssetsModel_idResourceAttribute", "exampleSetFlag" : false }, "workday_id" : { "$ref" : "#/components/schemas/AssetsWorkday_idResourceAttribute", "exampleSetFlag" : false }, "loss_description" : { "$ref" : "#/components/schemas/AssetsLoss_descriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetsCreated_byResourceAttribute", "exampleSetFlag" : false }, "accepted_by_id" : { "$ref" : "#/components/schemas/AssetsAccepted_by_idResourceAttribute", "exampleSetFlag" : false }, "usic_tag" : { "$ref" : "#/components/schemas/AssetsUsic_tagResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "book_value" : { "$ref" : "#/components/schemas/AssetsBook_valueResourceAttribute", "exampleSetFlag" : false }, "tracking_no" : { "$ref" : "#/components/schemas/AssetsTracking_noResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "mapping_id" : { "$ref" : "#/components/schemas/AssetsMapping_idResourceAttribute", "exampleSetFlag" : false }, "organization_id" : { "$ref" : "#/components/schemas/AssetsOrganization_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "purchase_price" : { "$ref" : "#/components/schemas/AssetsPurchase_priceResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "deletion_reason_id" : { "$ref" : "#/components/schemas/AssetsDeletion_reason_idResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AssetsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "purchase_date" : { "$ref" : "#/components/schemas/AssetsPurchase_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/AssetsSearch_textResourceAttribute", "exampleSetFlag" : false }, "supgroup_code" : { "$ref" : "#/components/schemas/AssetsSupgroup_codeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "notes" : { "$ref" : "#/components/schemas/AssetsNotesResourceAttribute", "exampleSetFlag" : false }, "original_creation_date" : { "$ref" : "#/components/schemas/AssetsOriginal_creation_dateResourceAttribute", "exampleSetFlag" : false }, "reference_id" : { "$ref" : "#/components/schemas/AssetsReference_idResourceAttribute", "exampleSetFlag" : false }, "repair_reason_id" : { "$ref" : "#/components/schemas/AssetsRepair_reason_idResourceAttribute", "exampleSetFlag" : false }, "warranty_end_date" : { "$ref" : "#/components/schemas/AssetsWarranty_end_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetsDescriptionResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/AssetsVersion_numberResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/AssetsAsset_idResourceAttribute", "exampleSetFlag" : false }, "location_id" : { "$ref" : "#/components/schemas/AssetsLocation_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/AssetsStatus_idResourceAttribute", "exampleSetFlag" : false }, "warranty" : { "$ref" : "#/components/schemas/AssetsWarrantyResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "in_transfer" : { "$ref" : "#/components/schemas/AssetsIn_transferResourceAttribute", "exampleSetFlag" : false }, "police_report_number" : { "$ref" : "#/components/schemas/AssetsPolice_report_numberResourceAttribute", "exampleSetFlag" : false }, "loss_date" : { "$ref" : "#/components/schemas/AssetsLoss_dateResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/AssetsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "warranty_start_date" : { "$ref" : "#/components/schemas/AssetsWarranty_start_dateResourceAttribute", "exampleSetFlag" : false }, "source_system" : { "$ref" : "#/components/schemas/AssetsSource_systemResourceAttribute", "exampleSetFlag" : false }, "loss_address" : { "$ref" : "#/components/schemas/AssetsLoss_addressResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/AssetsActiveResourceAttribute", "exampleSetFlag" : false }, "tax" : { "$ref" : "#/components/schemas/AssetsTaxResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/AssetsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "model_id" : { "$ref" : "#/components/schemas/AssetsModel_idResourceAttribute", "exampleSetFlag" : false }, "workday_id" : { "$ref" : "#/components/schemas/AssetsWorkday_idResourceAttribute", "exampleSetFlag" : false }, "loss_description" : { "$ref" : "#/components/schemas/AssetsLoss_descriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetsCreated_byResourceAttribute", "exampleSetFlag" : false }, "accepted_by_id" : { "$ref" : "#/components/schemas/AssetsAccepted_by_idResourceAttribute", "exampleSetFlag" : false }, "usic_tag" : { "$ref" : "#/components/schemas/AssetsUsic_tagResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "book_value" : { "$ref" : "#/components/schemas/AssetsBook_valueResourceAttribute", "exampleSetFlag" : false }, "tracking_no" : { "$ref" : "#/components/schemas/AssetsTracking_noResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AssetsCreated_onResourceAttribute", "exampleSetFlag" : false }, "mapping_id" : { "$ref" : "#/components/schemas/AssetsMapping_idResourceAttribute", "exampleSetFlag" : false }, "organization_id" : { "$ref" : "#/components/schemas/AssetsOrganization_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "purchase_price" : { "$ref" : "#/components/schemas/AssetsPurchase_priceResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "deletion_reason_id" : { "$ref" : "#/components/schemas/AssetsDeletion_reason_idResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AssetsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "purchase_date" : { "$ref" : "#/components/schemas/AssetsPurchase_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/AssetsSearch_textResourceAttribute", "exampleSetFlag" : false }, "supgroup_code" : { "$ref" : "#/components/schemas/AssetsSupgroup_codeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetsOriginal_creation_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetsIn_transferResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AssetsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetsResourceLinks", "exampleSetFlag" : false } ] }, "AssetsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AssetsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "lastAssignment" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/lastAssignment" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/lastAssignment" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locatorCheckins" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/locatorCheckins" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/locatorCheckins" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "repairReason" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/repairReason" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/repairReason" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetAttributeValues" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/assetAttributeValues" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/assetAttributeValues" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "netmotionDevices" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/netmotionDevices" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/netmotionDevices" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetModel" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/assetModel" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/assetModel" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeeAcceptedBy" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/employeeAcceptedBy" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/employeeAcceptedBy" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetAssignment" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/assetAssignment" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/assetAssignment" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/dist" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/dist" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supgroup" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/supgroup" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/supgroup" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "deletionType" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/deletionType" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/deletionType" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "location" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/location" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/location" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetStatus" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/assetStatus" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/assetStatus" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "categoryTypeMakeMapping" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/relationships/categoryTypeMakeMapping" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}/categoryTypeMakeMapping" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsWorkday_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsVersion_numberResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsPurchase_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetsLocation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsUsic_tagResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AssetsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AssetsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assets" ] }, "id" : { "$ref" : "#/components/schemas/AssetsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsWarranty_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetsSupgroup_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsWarrantyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AssetsNetmotionDevicesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (assets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "assets" ] }, "id" : { "$ref" : "#/components/schemas/AssetsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsLoss_descriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsCategoryTypeMakeMappingResourceAttribute" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "notes" : { "$ref" : "#/components/schemas/AssetsNotesResourceAttribute", "exampleSetFlag" : false }, "original_creation_date" : { "$ref" : "#/components/schemas/AssetsOriginal_creation_dateResourceAttribute", "exampleSetFlag" : false }, "reference_id" : { "$ref" : "#/components/schemas/AssetsReference_idResourceAttribute", "exampleSetFlag" : false }, "repair_reason_id" : { "$ref" : "#/components/schemas/AssetsRepair_reason_idResourceAttribute", "exampleSetFlag" : false }, "warranty_end_date" : { "$ref" : "#/components/schemas/AssetsWarranty_end_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AssetsDescriptionResourceAttribute", "exampleSetFlag" : false }, "location_id" : { "$ref" : "#/components/schemas/AssetsLocation_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AssetsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/AssetsStatus_idResourceAttribute", "exampleSetFlag" : false }, "warranty" : { "$ref" : "#/components/schemas/AssetsWarrantyResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AssetsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "in_transfer" : { "$ref" : "#/components/schemas/AssetsIn_transferResourceAttribute", "exampleSetFlag" : false }, "police_report_number" : { "$ref" : "#/components/schemas/AssetsPolice_report_numberResourceAttribute", "exampleSetFlag" : false }, "loss_date" : { "$ref" : "#/components/schemas/AssetsLoss_dateResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/AssetsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "warranty_start_date" : { "$ref" : "#/components/schemas/AssetsWarranty_start_dateResourceAttribute", "exampleSetFlag" : false }, "source_system" : { "$ref" : "#/components/schemas/AssetsSource_systemResourceAttribute", "exampleSetFlag" : false }, "loss_address" : { "$ref" : "#/components/schemas/AssetsLoss_addressResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/AssetsActiveResourceAttribute", "exampleSetFlag" : false }, "tax" : { "$ref" : "#/components/schemas/AssetsTaxResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/AssetsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "model_id" : { "$ref" : "#/components/schemas/AssetsModel_idResourceAttribute", "exampleSetFlag" : false }, "workday_id" : { "$ref" : "#/components/schemas/AssetsWorkday_idResourceAttribute", "exampleSetFlag" : false }, "loss_description" : { "$ref" : "#/components/schemas/AssetsLoss_descriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AssetsCreated_byResourceAttribute", "exampleSetFlag" : false }, "accepted_by_id" : { "$ref" : "#/components/schemas/AssetsAccepted_by_idResourceAttribute", "exampleSetFlag" : false }, "usic_tag" : { "$ref" : "#/components/schemas/AssetsUsic_tagResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AssetsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "book_value" : { "$ref" : "#/components/schemas/AssetsBook_valueResourceAttribute", "exampleSetFlag" : false }, "tracking_no" : { "$ref" : "#/components/schemas/AssetsTracking_noResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AssetsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "mapping_id" : { "$ref" : "#/components/schemas/AssetsMapping_idResourceAttribute", "exampleSetFlag" : false }, "organization_id" : { "$ref" : "#/components/schemas/AssetsOrganization_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AssetsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "purchase_price" : { "$ref" : "#/components/schemas/AssetsPurchase_priceResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AssetsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AssetsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "deletion_reason_id" : { "$ref" : "#/components/schemas/AssetsDeletion_reason_idResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AssetsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AssetsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "purchase_date" : { "$ref" : "#/components/schemas/AssetsPurchase_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/AssetsSearch_textResourceAttribute", "exampleSetFlag" : false }, "supgroup_code" : { "$ref" : "#/components/schemas/AssetsSupgroup_codeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsAccepted_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "locatorCheckins" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "repairReason" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetAttributeValues" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetModel" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetAssignment" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "deletionType" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "location" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetStatus" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "categoryTypeMakeMapping" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsAssetStatusResourceAttribute" : { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsSource_systemResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetsLoss_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetsLocationResourceAttribute" : { "$ref" : "#/components/schemas/LocationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsRepairReasonResourceAttribute" : { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsLastAssignmentResourceAttribute" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AssetsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AssetsResourcePostRelationships", "exampleSetFlag" : false } ] }, "AssetsRepair_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsSupgroupResourceAttribute" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsLocatorCheckinsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AssetsDistResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/assets/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsBook_valueResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AssetsAsset_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetsNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsTaxResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AssetsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsIdResourceAttribute" : { "type" : "object", "properties" : { "asset_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "version_number" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsOrganization_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsReference_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AssetsModel_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsWarranty_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AssetsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsMapping_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AssetsAssetAssignmentResourceAttribute" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "nullable" : false, "exampleSetFlag" : false }, "AssetsSearch_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsAssetModelResourceAttribute" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsPurchase_priceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AssetsPolice_report_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AssetsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AssetsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AssetsEmployeeAcceptedByResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AssetsSerial_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsLoss_addressResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AssetsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "locatorCheckins" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "repairReason" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetAttributeValues" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetModel" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetAssignment" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "deletionType" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "location" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetStatus" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetStatusesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "categoryTypeMakeMapping" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_type" : { "$ref" : "#/components/schemas/AttAccountsAccount_typeResourceAttribute", "exampleSetFlag" : false }, "account_group" : { "$ref" : "#/components/schemas/AttAccountsAccount_groupResourceAttribute", "exampleSetFlag" : false }, "account_group_id" : { "$ref" : "#/components/schemas/AttAccountsAccount_group_idResourceAttribute", "exampleSetFlag" : false }, "account_level_value" : { "$ref" : "#/components/schemas/AttAccountsAccount_level_valueResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttAccountsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttAccountsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttAccountsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttAccountsResourcePostAttributes", "exampleSetFlag" : false } ] }, "AttAccountsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttAccountsAccount_level_valueResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttAccountsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attAccounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attAccounts" ] }, "id" : { "$ref" : "#/components/schemas/AttAccountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttAccountsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttAccountsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsAccount_groupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttAccountsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_type" : { "$ref" : "#/components/schemas/AttAccountsAccount_typeResourceAttribute", "exampleSetFlag" : false }, "account_group" : { "$ref" : "#/components/schemas/AttAccountsAccount_groupResourceAttribute", "exampleSetFlag" : false }, "account_group_id" : { "$ref" : "#/components/schemas/AttAccountsAccount_group_idResourceAttribute", "exampleSetFlag" : false }, "account_level_value" : { "$ref" : "#/components/schemas/AttAccountsAccount_level_valueResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsAccount_group_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttAccountsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attAccounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attAccounts" ] }, "id" : { "$ref" : "#/components/schemas/AttAccountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttAccountsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttAccountsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttAccountsResourceLinks", "exampleSetFlag" : false } ] }, "AttAccountsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttAccountsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttAccountsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttAccountsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttAccountsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_type" : { "$ref" : "#/components/schemas/AttAccountsAccount_typeResourceAttribute", "exampleSetFlag" : false }, "account_group" : { "$ref" : "#/components/schemas/AttAccountsAccount_groupResourceAttribute", "exampleSetFlag" : false }, "account_group_id" : { "$ref" : "#/components/schemas/AttAccountsAccount_group_idResourceAttribute", "exampleSetFlag" : false }, "account_level_value" : { "$ref" : "#/components/schemas/AttAccountsAccount_level_valueResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attAccounts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttAccountsAccount_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttAccountsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttAccountsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsCapacityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsFn5g_capableResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AttProductCatalogItemsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttProductCatalogItemsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttProductCatalogItemsCompatible_servicesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsLong_descriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsCompatible_rateplansResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attProductCatalogItems/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttProductCatalogItemsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttProductCatalogItemsResourcePostAttributes", "exampleSetFlag" : false } ] }, "AttProductCatalogItemsItem_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsExpiration_dateResourceAttribute" : { "type" : "string", "format" : "date", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "charge_type" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCharge_typeResourceAttribute", "exampleSetFlag" : false }, "plan_type" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPlan_typeResourceAttribute", "exampleSetFlag" : false }, "color" : { "$ref" : "#/components/schemas/AttProductCatalogItemsColorResourceAttribute", "exampleSetFlag" : false }, "incompatible_services" : { "$ref" : "#/components/schemas/AttProductCatalogItemsIncompatible_servicesResourceAttribute", "exampleSetFlag" : false }, "item_type" : { "$ref" : "#/components/schemas/AttProductCatalogItemsItem_typeResourceAttribute", "exampleSetFlag" : false }, "unit_measurement" : { "$ref" : "#/components/schemas/AttProductCatalogItemsUnit_measurementResourceAttribute", "exampleSetFlag" : false }, "mutually_exclusive_features" : { "$ref" : "#/components/schemas/AttProductCatalogItemsMutually_exclusive_featuresResourceAttribute", "exampleSetFlag" : false }, "fn5g_capable" : { "$ref" : "#/components/schemas/AttProductCatalogItemsFn5g_capableResourceAttribute", "exampleSetFlag" : false }, "compatible_rateplans" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCompatible_rateplansResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AttProductCatalogItemsDescriptionResourceAttribute", "exampleSetFlag" : false }, "plan_subtype" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPlan_subtypeResourceAttribute", "exampleSetFlag" : false }, "long_description" : { "$ref" : "#/components/schemas/AttProductCatalogItemsLong_descriptionResourceAttribute", "exampleSetFlag" : false }, "unit_price" : { "$ref" : "#/components/schemas/AttProductCatalogItemsUnit_priceResourceAttribute", "exampleSetFlag" : false }, "expiration_date" : { "$ref" : "#/components/schemas/AttProductCatalogItemsExpiration_dateResourceAttribute", "exampleSetFlag" : false }, "manufacturer" : { "$ref" : "#/components/schemas/AttProductCatalogItemsManufacturerResourceAttribute", "exampleSetFlag" : false }, "capacity" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCapacityResourceAttribute", "exampleSetFlag" : false }, "soc_code" : { "$ref" : "#/components/schemas/AttProductCatalogItemsSoc_codeResourceAttribute", "exampleSetFlag" : false }, "compatible_services" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCompatible_servicesResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/AttProductCatalogItemsEffective_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttProductCatalogItemsLast_updated_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsPlan_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsIncompatible_servicesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsManufacturerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsMutually_exclusive_featuresResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsColorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttProductCatalogItemsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsPlan_subtypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsEffective_dateResourceAttribute" : { "type" : "string", "format" : "date", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attProductCatalogItems)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attProductCatalogItems" ] }, "id" : { "$ref" : "#/components/schemas/AttProductCatalogItemsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsUnit_priceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AttProductCatalogItemsUnit_measurementResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "charge_type" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCharge_typeResourceAttribute", "exampleSetFlag" : false }, "plan_type" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPlan_typeResourceAttribute", "exampleSetFlag" : false }, "color" : { "$ref" : "#/components/schemas/AttProductCatalogItemsColorResourceAttribute", "exampleSetFlag" : false }, "incompatible_services" : { "$ref" : "#/components/schemas/AttProductCatalogItemsIncompatible_servicesResourceAttribute", "exampleSetFlag" : false }, "item_type" : { "$ref" : "#/components/schemas/AttProductCatalogItemsItem_typeResourceAttribute", "exampleSetFlag" : false }, "unit_measurement" : { "$ref" : "#/components/schemas/AttProductCatalogItemsUnit_measurementResourceAttribute", "exampleSetFlag" : false }, "mutually_exclusive_features" : { "$ref" : "#/components/schemas/AttProductCatalogItemsMutually_exclusive_featuresResourceAttribute", "exampleSetFlag" : false }, "fn5g_capable" : { "$ref" : "#/components/schemas/AttProductCatalogItemsFn5g_capableResourceAttribute", "exampleSetFlag" : false }, "compatible_rateplans" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCompatible_rateplansResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AttProductCatalogItemsDescriptionResourceAttribute", "exampleSetFlag" : false }, "plan_subtype" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPlan_subtypeResourceAttribute", "exampleSetFlag" : false }, "long_description" : { "$ref" : "#/components/schemas/AttProductCatalogItemsLong_descriptionResourceAttribute", "exampleSetFlag" : false }, "unit_price" : { "$ref" : "#/components/schemas/AttProductCatalogItemsUnit_priceResourceAttribute", "exampleSetFlag" : false }, "expiration_date" : { "$ref" : "#/components/schemas/AttProductCatalogItemsExpiration_dateResourceAttribute", "exampleSetFlag" : false }, "manufacturer" : { "$ref" : "#/components/schemas/AttProductCatalogItemsManufacturerResourceAttribute", "exampleSetFlag" : false }, "capacity" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCapacityResourceAttribute", "exampleSetFlag" : false }, "soc_code" : { "$ref" : "#/components/schemas/AttProductCatalogItemsSoc_codeResourceAttribute", "exampleSetFlag" : false }, "compatible_services" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCompatible_servicesResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/AttProductCatalogItemsEffective_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttProductCatalogItemsLast_updated_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsCharge_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceLinks", "exampleSetFlag" : false } ] }, "AttProductCatalogItemsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "charge_type" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCharge_typeResourceAttribute", "exampleSetFlag" : false }, "plan_type" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPlan_typeResourceAttribute", "exampleSetFlag" : false }, "color" : { "$ref" : "#/components/schemas/AttProductCatalogItemsColorResourceAttribute", "exampleSetFlag" : false }, "incompatible_services" : { "$ref" : "#/components/schemas/AttProductCatalogItemsIncompatible_servicesResourceAttribute", "exampleSetFlag" : false }, "item_type" : { "$ref" : "#/components/schemas/AttProductCatalogItemsItem_typeResourceAttribute", "exampleSetFlag" : false }, "unit_measurement" : { "$ref" : "#/components/schemas/AttProductCatalogItemsUnit_measurementResourceAttribute", "exampleSetFlag" : false }, "mutually_exclusive_features" : { "$ref" : "#/components/schemas/AttProductCatalogItemsMutually_exclusive_featuresResourceAttribute", "exampleSetFlag" : false }, "fn5g_capable" : { "$ref" : "#/components/schemas/AttProductCatalogItemsFn5g_capableResourceAttribute", "exampleSetFlag" : false }, "compatible_rateplans" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCompatible_rateplansResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/AttProductCatalogItemsDescriptionResourceAttribute", "exampleSetFlag" : false }, "plan_subtype" : { "$ref" : "#/components/schemas/AttProductCatalogItemsPlan_subtypeResourceAttribute", "exampleSetFlag" : false }, "long_description" : { "$ref" : "#/components/schemas/AttProductCatalogItemsLong_descriptionResourceAttribute", "exampleSetFlag" : false }, "unit_price" : { "$ref" : "#/components/schemas/AttProductCatalogItemsUnit_priceResourceAttribute", "exampleSetFlag" : false }, "expiration_date" : { "$ref" : "#/components/schemas/AttProductCatalogItemsExpiration_dateResourceAttribute", "exampleSetFlag" : false }, "manufacturer" : { "$ref" : "#/components/schemas/AttProductCatalogItemsManufacturerResourceAttribute", "exampleSetFlag" : false }, "capacity" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCapacityResourceAttribute", "exampleSetFlag" : false }, "soc_code" : { "$ref" : "#/components/schemas/AttProductCatalogItemsSoc_codeResourceAttribute", "exampleSetFlag" : false }, "compatible_services" : { "$ref" : "#/components/schemas/AttProductCatalogItemsCompatible_servicesResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/AttProductCatalogItemsEffective_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttProductCatalogItemsSoc_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttProductCatalogItemsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attProductCatalogItems)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attProductCatalogItems" ] }, "id" : { "$ref" : "#/components/schemas/AttProductCatalogItemsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttProductCatalogItemsIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttWirelessInventoriesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesOs_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesTechnology_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attWirelessInventories/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesUdl3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesFanResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttWirelessInventoriesBanResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesImeiResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesDevice_modelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "device_model" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDevice_modelResourceAttribute", "exampleSetFlag" : false }, "wireless_user_full_name" : { "$ref" : "#/components/schemas/AttWirelessInventoriesWireless_user_full_nameResourceAttribute", "exampleSetFlag" : false }, "sim_number" : { "$ref" : "#/components/schemas/AttWirelessInventoriesSim_numberResourceAttribute", "exampleSetFlag" : false }, "ban" : { "$ref" : "#/components/schemas/AttWirelessInventoriesBanResourceAttribute", "exampleSetFlag" : false }, "contract_start_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesContract_start_dateResourceAttribute", "exampleSetFlag" : false }, "device_effective_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDevice_effective_dateResourceAttribute", "exampleSetFlag" : false }, "contract_end_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesContract_end_dateResourceAttribute", "exampleSetFlag" : false }, "fan" : { "$ref" : "#/components/schemas/AttWirelessInventoriesFanResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttWirelessInventoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "status_effective_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesStatus_effective_dateResourceAttribute", "exampleSetFlag" : false }, "wireless_user_activation_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesWireless_user_activation_dateResourceAttribute", "exampleSetFlag" : false }, "udl3" : { "$ref" : "#/components/schemas/AttWirelessInventoriesUdl3ResourceAttribute", "exampleSetFlag" : false }, "udl4" : { "$ref" : "#/components/schemas/AttWirelessInventoriesUdl4ResourceAttribute", "exampleSetFlag" : false }, "technology_type" : { "$ref" : "#/components/schemas/AttWirelessInventoriesTechnology_typeResourceAttribute", "exampleSetFlag" : false }, "sim_type" : { "$ref" : "#/components/schemas/AttWirelessInventoriesSim_typeResourceAttribute", "exampleSetFlag" : false }, "wireless_user_status" : { "$ref" : "#/components/schemas/AttWirelessInventoriesWireless_user_statusResourceAttribute", "exampleSetFlag" : false }, "serivce_type" : { "$ref" : "#/components/schemas/AttWirelessInventoriesSerivce_typeResourceAttribute", "exampleSetFlag" : false }, "os_version" : { "$ref" : "#/components/schemas/AttWirelessInventoriesOs_versionResourceAttribute", "exampleSetFlag" : false }, "billing_account_name" : { "$ref" : "#/components/schemas/AttWirelessInventoriesBilling_account_nameResourceAttribute", "exampleSetFlag" : false }, "rate_plan_name" : { "$ref" : "#/components/schemas/AttWirelessInventoriesRate_plan_nameResourceAttribute", "exampleSetFlag" : false }, "device_make" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDevice_makeResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AttWirelessInventoriesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "imeisv" : { "$ref" : "#/components/schemas/AttWirelessInventoriesImeisvResourceAttribute", "exampleSetFlag" : false }, "imei" : { "$ref" : "#/components/schemas/AttWirelessInventoriesImeiResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDistrict_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesStatus_effective_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AttWirelessInventoriesWireless_user_activation_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AttWirelessInventoriesDevice_effective_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AttWirelessInventoriesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attWirelessInventories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attWirelessInventories" ] }, "id" : { "$ref" : "#/components/schemas/AttWirelessInventoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attWirelessInventories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attWirelessInventories" ] }, "id" : { "$ref" : "#/components/schemas/AttWirelessInventoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesContract_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AttWirelessInventoriesUdl4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttWirelessInventoriesWireless_user_full_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttWirelessInventoriesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesDevice_makeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceLinks", "exampleSetFlag" : false } ] }, "AttWirelessInventoriesSim_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesWireless_user_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesContract_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AttWirelessInventoriesEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttWirelessInventoriesIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttWirelessInventoriesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttWirelessInventoriesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AttWirelessInventoriesSim_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttWirelessInventoriesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttWirelessInventoriesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttWirelessInventoriesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "device_model" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDevice_modelResourceAttribute", "exampleSetFlag" : false }, "wireless_user_full_name" : { "$ref" : "#/components/schemas/AttWirelessInventoriesWireless_user_full_nameResourceAttribute", "exampleSetFlag" : false }, "sim_number" : { "$ref" : "#/components/schemas/AttWirelessInventoriesSim_numberResourceAttribute", "exampleSetFlag" : false }, "ban" : { "$ref" : "#/components/schemas/AttWirelessInventoriesBanResourceAttribute", "exampleSetFlag" : false }, "contract_start_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesContract_start_dateResourceAttribute", "exampleSetFlag" : false }, "device_effective_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDevice_effective_dateResourceAttribute", "exampleSetFlag" : false }, "contract_end_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesContract_end_dateResourceAttribute", "exampleSetFlag" : false }, "fan" : { "$ref" : "#/components/schemas/AttWirelessInventoriesFanResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttWirelessInventoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "status_effective_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesStatus_effective_dateResourceAttribute", "exampleSetFlag" : false }, "wireless_user_activation_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesWireless_user_activation_dateResourceAttribute", "exampleSetFlag" : false }, "udl3" : { "$ref" : "#/components/schemas/AttWirelessInventoriesUdl3ResourceAttribute", "exampleSetFlag" : false }, "udl4" : { "$ref" : "#/components/schemas/AttWirelessInventoriesUdl4ResourceAttribute", "exampleSetFlag" : false }, "technology_type" : { "$ref" : "#/components/schemas/AttWirelessInventoriesTechnology_typeResourceAttribute", "exampleSetFlag" : false }, "sim_type" : { "$ref" : "#/components/schemas/AttWirelessInventoriesSim_typeResourceAttribute", "exampleSetFlag" : false }, "wireless_user_status" : { "$ref" : "#/components/schemas/AttWirelessInventoriesWireless_user_statusResourceAttribute", "exampleSetFlag" : false }, "serivce_type" : { "$ref" : "#/components/schemas/AttWirelessInventoriesSerivce_typeResourceAttribute", "exampleSetFlag" : false }, "os_version" : { "$ref" : "#/components/schemas/AttWirelessInventoriesOs_versionResourceAttribute", "exampleSetFlag" : false }, "billing_account_name" : { "$ref" : "#/components/schemas/AttWirelessInventoriesBilling_account_nameResourceAttribute", "exampleSetFlag" : false }, "rate_plan_name" : { "$ref" : "#/components/schemas/AttWirelessInventoriesRate_plan_nameResourceAttribute", "exampleSetFlag" : false }, "device_make" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDevice_makeResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AttWirelessInventoriesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "imeisv" : { "$ref" : "#/components/schemas/AttWirelessInventoriesImeisvResourceAttribute", "exampleSetFlag" : false }, "imei" : { "$ref" : "#/components/schemas/AttWirelessInventoriesImeiResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDistrict_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesImeisvResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesBilling_account_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesSerivce_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoriesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "udl3" : { "$ref" : "#/components/schemas/AttWirelessInventoriesUdl3ResourceAttribute", "exampleSetFlag" : false }, "udl4" : { "$ref" : "#/components/schemas/AttWirelessInventoriesUdl4ResourceAttribute", "exampleSetFlag" : false }, "technology_type" : { "$ref" : "#/components/schemas/AttWirelessInventoriesTechnology_typeResourceAttribute", "exampleSetFlag" : false }, "device_model" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDevice_modelResourceAttribute", "exampleSetFlag" : false }, "sim_type" : { "$ref" : "#/components/schemas/AttWirelessInventoriesSim_typeResourceAttribute", "exampleSetFlag" : false }, "wireless_user_status" : { "$ref" : "#/components/schemas/AttWirelessInventoriesWireless_user_statusResourceAttribute", "exampleSetFlag" : false }, "serivce_type" : { "$ref" : "#/components/schemas/AttWirelessInventoriesSerivce_typeResourceAttribute", "exampleSetFlag" : false }, "os_version" : { "$ref" : "#/components/schemas/AttWirelessInventoriesOs_versionResourceAttribute", "exampleSetFlag" : false }, "wireless_user_full_name" : { "$ref" : "#/components/schemas/AttWirelessInventoriesWireless_user_full_nameResourceAttribute", "exampleSetFlag" : false }, "sim_number" : { "$ref" : "#/components/schemas/AttWirelessInventoriesSim_numberResourceAttribute", "exampleSetFlag" : false }, "billing_account_name" : { "$ref" : "#/components/schemas/AttWirelessInventoriesBilling_account_nameResourceAttribute", "exampleSetFlag" : false }, "ban" : { "$ref" : "#/components/schemas/AttWirelessInventoriesBanResourceAttribute", "exampleSetFlag" : false }, "contract_start_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesContract_start_dateResourceAttribute", "exampleSetFlag" : false }, "device_effective_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDevice_effective_dateResourceAttribute", "exampleSetFlag" : false }, "contract_end_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesContract_end_dateResourceAttribute", "exampleSetFlag" : false }, "rate_plan_name" : { "$ref" : "#/components/schemas/AttWirelessInventoriesRate_plan_nameResourceAttribute", "exampleSetFlag" : false }, "device_make" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDevice_makeResourceAttribute", "exampleSetFlag" : false }, "fan" : { "$ref" : "#/components/schemas/AttWirelessInventoriesFanResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/AttWirelessInventoriesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "imeisv" : { "$ref" : "#/components/schemas/AttWirelessInventoriesImeisvResourceAttribute", "exampleSetFlag" : false }, "imei" : { "$ref" : "#/components/schemas/AttWirelessInventoriesImeiResourceAttribute", "exampleSetFlag" : false }, "status_effective_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesStatus_effective_dateResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/AttWirelessInventoriesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "wireless_user_activation_date" : { "$ref" : "#/components/schemas/AttWirelessInventoriesWireless_user_activation_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoriesRate_plan_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesData_usage_2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attWirelessInventoryUsages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attWirelessInventoryUsages" ] }, "id" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesData_plan_name_2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesFanResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "data_plan_name_2" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_2ResourceAttribute", "exampleSetFlag" : false }, "data_plan_name_1" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_1ResourceAttribute", "exampleSetFlag" : false }, "ban" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesBanResourceAttribute", "exampleSetFlag" : false }, "data_usage_3" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_3ResourceAttribute", "exampleSetFlag" : false }, "data_usage_4" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_4ResourceAttribute", "exampleSetFlag" : false }, "data_usage_1" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_1ResourceAttribute", "exampleSetFlag" : false }, "data_usage_2" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_2ResourceAttribute", "exampleSetFlag" : false }, "fan" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesFanResourceAttribute", "exampleSetFlag" : false }, "voice_minutes_anytime" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesVoice_minutes_anytimeResourceAttribute", "exampleSetFlag" : false }, "data_plan_name_4" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_4ResourceAttribute", "exampleSetFlag" : false }, "billing_cycle_end_date" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesBilling_cycle_end_dateResourceAttribute", "exampleSetFlag" : false }, "data_plan_name_3" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "usage_requested_date" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesUsage_requested_dateResourceAttribute", "exampleSetFlag" : false }, "voice_plan_name" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesVoice_plan_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesVoice_minutes_anytimeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttWirelessInventoryUsagesBanResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttWirelessInventoryUsagesData_plan_name_3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesData_usage_3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesData_plan_name_1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesData_usage_1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "data_plan_name_2" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_2ResourceAttribute", "exampleSetFlag" : false }, "data_plan_name_1" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_1ResourceAttribute", "exampleSetFlag" : false }, "ban" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesBanResourceAttribute", "exampleSetFlag" : false }, "data_usage_3" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_3ResourceAttribute", "exampleSetFlag" : false }, "data_usage_4" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_4ResourceAttribute", "exampleSetFlag" : false }, "data_usage_1" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_1ResourceAttribute", "exampleSetFlag" : false }, "data_usage_2" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_2ResourceAttribute", "exampleSetFlag" : false }, "fan" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesFanResourceAttribute", "exampleSetFlag" : false }, "voice_minutes_anytime" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesVoice_minutes_anytimeResourceAttribute", "exampleSetFlag" : false }, "data_plan_name_4" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_4ResourceAttribute", "exampleSetFlag" : false }, "billing_cycle_end_date" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesBilling_cycle_end_dateResourceAttribute", "exampleSetFlag" : false }, "data_plan_name_3" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_3ResourceAttribute", "exampleSetFlag" : false }, "usage_requested_date" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesUsage_requested_dateResourceAttribute", "exampleSetFlag" : false }, "voice_plan_name" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesVoice_plan_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attWirelessInventoryUsages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attWirelessInventoryUsages" ] }, "id" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesData_plan_name_4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "data_plan_name_2" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_2ResourceAttribute", "exampleSetFlag" : false }, "data_plan_name_1" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_1ResourceAttribute", "exampleSetFlag" : false }, "ban" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesBanResourceAttribute", "exampleSetFlag" : false }, "data_usage_3" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_3ResourceAttribute", "exampleSetFlag" : false }, "data_usage_4" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_4ResourceAttribute", "exampleSetFlag" : false }, "data_usage_1" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_1ResourceAttribute", "exampleSetFlag" : false }, "data_usage_2" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_usage_2ResourceAttribute", "exampleSetFlag" : false }, "fan" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesFanResourceAttribute", "exampleSetFlag" : false }, "voice_minutes_anytime" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesVoice_minutes_anytimeResourceAttribute", "exampleSetFlag" : false }, "data_plan_name_4" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_4ResourceAttribute", "exampleSetFlag" : false }, "billing_cycle_end_date" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesBilling_cycle_end_dateResourceAttribute", "exampleSetFlag" : false }, "data_plan_name_3" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesData_plan_name_3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "usage_requested_date" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesUsage_requested_dateResourceAttribute", "exampleSetFlag" : false }, "voice_plan_name" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesVoice_plan_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesData_usage_4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttWirelessInventoryUsagesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourcePostAttributes", "exampleSetFlag" : false } ] }, "AttWirelessInventoryUsagesBilling_cycle_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AttWirelessInventoryUsagesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attWirelessInventoryUsages/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttWirelessInventoryUsagesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesUsage_requested_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AttWirelessInventoryUsagesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttWirelessInventoryUsagesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceLinks", "exampleSetFlag" : false } ] }, "AttWirelessInventoryUsagesVoice_plan_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachEntitiesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachEntitiesPostResourceReference", "exampleSetFlag" : false } ] }, "AttachEntitiesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/AttachEntitiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AttachEntitiesCreated_onResourceAttribute", "exampleSetFlag" : false }, "entity_table" : { "$ref" : "#/components/schemas/AttachEntitiesEntity_tableResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_name" : { "$ref" : "#/components/schemas/AttachEntitiesAttachment_entity_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttachEntitiesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttachEntitiesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachEntitiesAttachment_entity_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachEntitiesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttachEntitiesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachEntitiesEntity_tableResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachEntitiesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachEntitiesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachEntities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachEntities" ] }, "id" : { "$ref" : "#/components/schemas/AttachEntitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachEntitiesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachEntitiesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachEntitiesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachEntitiesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachEntitiesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachEntitiesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttachEntitiesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/attachmentEntities/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachEntitiesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachEntitiesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachEntitiesResourceLinks", "exampleSetFlag" : false } ] }, "AttachEntitiesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttachEntitiesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachEntitiesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachEntitiesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttachEntitiesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttachEntitiesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachEntitiesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachEntities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachEntities" ] }, "id" : { "$ref" : "#/components/schemas/AttachEntitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachEntitiesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "filetype" : { "$ref" : "#/components/schemas/AttachmentFiletypeResourceAttribute", "exampleSetFlag" : false }, "pk2_var" : { "$ref" : "#/components/schemas/AttachmentPk2_varResourceAttribute", "exampleSetFlag" : false }, "pk3_int" : { "$ref" : "#/components/schemas/AttachmentPk3_intResourceAttribute", "exampleSetFlag" : false }, "volume_id" : { "$ref" : "#/components/schemas/AttachmentVolume_idResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_id" : { "$ref" : "#/components/schemas/AttachmentAttachment_entity_idResourceAttribute", "exampleSetFlag" : false }, "pk1_int" : { "$ref" : "#/components/schemas/AttachmentPk1_intResourceAttribute", "exampleSetFlag" : false }, "filesize" : { "$ref" : "#/components/schemas/AttachmentFilesizeResourceAttribute", "exampleSetFlag" : false }, "pk3_var" : { "$ref" : "#/components/schemas/AttachmentPk3_varResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttachmentCreated_byResourceAttribute", "exampleSetFlag" : false }, "path" : { "$ref" : "#/components/schemas/AttachmentPathResourceAttribute", "exampleSetFlag" : false }, "pk1_var" : { "$ref" : "#/components/schemas/AttachmentPk1_varResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AttachmentLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "filename" : { "$ref" : "#/components/schemas/AttachmentFilenameResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AttachmentCreated_onResourceAttribute", "exampleSetFlag" : false }, "pk2_int" : { "$ref" : "#/components/schemas/AttachmentPk2_intResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttachmentLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "priv" : { "$ref" : "#/components/schemas/AttachmentPrivResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentFilenameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "filetype" : { "$ref" : "#/components/schemas/AttachmentFiletypeResourceAttribute", "exampleSetFlag" : false }, "pk2_var" : { "$ref" : "#/components/schemas/AttachmentPk2_varResourceAttribute", "exampleSetFlag" : false }, "pk3_int" : { "$ref" : "#/components/schemas/AttachmentPk3_intResourceAttribute", "exampleSetFlag" : false }, "volume_id" : { "$ref" : "#/components/schemas/AttachmentVolume_idResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_id" : { "$ref" : "#/components/schemas/AttachmentAttachment_entity_idResourceAttribute", "exampleSetFlag" : false }, "pk1_int" : { "$ref" : "#/components/schemas/AttachmentPk1_intResourceAttribute", "exampleSetFlag" : false }, "filesize" : { "$ref" : "#/components/schemas/AttachmentFilesizeResourceAttribute", "exampleSetFlag" : false }, "pk3_var" : { "$ref" : "#/components/schemas/AttachmentPk3_varResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttachmentCreated_byResourceAttribute", "exampleSetFlag" : false }, "path" : { "$ref" : "#/components/schemas/AttachmentPathResourceAttribute", "exampleSetFlag" : false }, "pk1_var" : { "$ref" : "#/components/schemas/AttachmentPk1_varResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AttachmentLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "filename" : { "$ref" : "#/components/schemas/AttachmentFilenameResourceAttribute", "exampleSetFlag" : false }, "pk2_int" : { "$ref" : "#/components/schemas/AttachmentPk2_intResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttachmentLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "priv" : { "$ref" : "#/components/schemas/AttachmentPrivResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentFilesizeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttachmentPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "storageVolume" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentEntity" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentPk1_varResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentResourceLinks", "exampleSetFlag" : false } ] }, "AttachmentResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "storageVolume" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachments/{id}/relationships/storageVolume" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachments/{id}/storageVolume" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentEntity" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachments/{id}/relationships/attachmentEntity" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachments/{id}/attachmentEntity" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttachmentStorageVolumeResourceAttribute" : { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttachmentVolume_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachments/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentPk1_intResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttachmentPk3_varResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentPathResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachment)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachment" ] }, "id" : { "$ref" : "#/components/schemas/AttachmentIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachment)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachment" ] }, "id" : { "$ref" : "#/components/schemas/AttachmentIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentPk3_intResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentAttachment_entity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "storageVolume" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentEntity" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentAttachmentEntityResourceAttribute" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttachmentResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "filetype" : { "$ref" : "#/components/schemas/AttachmentFiletypeResourceAttribute", "exampleSetFlag" : false }, "pk2_var" : { "$ref" : "#/components/schemas/AttachmentPk2_varResourceAttribute", "exampleSetFlag" : false }, "pk3_int" : { "$ref" : "#/components/schemas/AttachmentPk3_intResourceAttribute", "exampleSetFlag" : false }, "volume_id" : { "$ref" : "#/components/schemas/AttachmentVolume_idResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_id" : { "$ref" : "#/components/schemas/AttachmentAttachment_entity_idResourceAttribute", "exampleSetFlag" : false }, "pk1_int" : { "$ref" : "#/components/schemas/AttachmentPk1_intResourceAttribute", "exampleSetFlag" : false }, "filesize" : { "$ref" : "#/components/schemas/AttachmentFilesizeResourceAttribute", "exampleSetFlag" : false }, "pk3_var" : { "$ref" : "#/components/schemas/AttachmentPk3_varResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttachmentCreated_byResourceAttribute", "exampleSetFlag" : false }, "path" : { "$ref" : "#/components/schemas/AttachmentPathResourceAttribute", "exampleSetFlag" : false }, "pk1_var" : { "$ref" : "#/components/schemas/AttachmentPk1_varResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AttachmentLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "filename" : { "$ref" : "#/components/schemas/AttachmentFilenameResourceAttribute", "exampleSetFlag" : false }, "pk2_int" : { "$ref" : "#/components/schemas/AttachmentPk2_intResourceAttribute", "exampleSetFlag" : false }, "priv" : { "$ref" : "#/components/schemas/AttachmentPrivResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentPk2_intResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentResourcePostRelationships", "exampleSetFlag" : false } ] }, "AttachmentResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttachmentPrivResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AttachmentPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentFiletypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentPk2_varResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentEntitiesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttachmentEntitiesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/AttachmentEntitiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "entity_table" : { "$ref" : "#/components/schemas/AttachmentEntitiesEntity_tableResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_name" : { "$ref" : "#/components/schemas/AttachmentEntitiesAttachment_entity_nameResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/AttachmentEntitiesApplication_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttachmentEntitiesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesAttachmentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "AttachmentEntitiesAttachment_entity_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentEntitiesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentEntitiesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourcePostRelationships", "exampleSetFlag" : false } ] }, "AttachmentEntitiesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachmentEntities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachmentEntities" ] }, "id" : { "$ref" : "#/components/schemas/AttachmentEntitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesApplication_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentEntitiesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/AttachmentEntitiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "entity_table" : { "$ref" : "#/components/schemas/AttachmentEntitiesEntity_tableResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_name" : { "$ref" : "#/components/schemas/AttachmentEntitiesAttachment_entity_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttachmentEntitiesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/AttachmentEntitiesApplication_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttachmentEntitiesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/AttachmentEntitiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AttachmentEntitiesCreated_onResourceAttribute", "exampleSetFlag" : false }, "entity_table" : { "$ref" : "#/components/schemas/AttachmentEntitiesEntity_tableResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_name" : { "$ref" : "#/components/schemas/AttachmentEntitiesAttachment_entity_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttachmentEntitiesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/AttachmentEntitiesApplication_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttachmentEntitiesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentEntitiesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "attachments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachmentEntities/{id}/relationships/attachments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachmentEntities/{id}/attachments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "application" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachmentEntities/{id}/relationships/application" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachmentEntities/{id}/application" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentEntitiesResourceLinks", "exampleSetFlag" : false } ] }, "AttachmentEntitiesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttachmentEntitiesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttachmentEntitiesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentEntitiesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesEntity_tableResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentEntitiesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "application" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "application" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentEntitiesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachmentEntities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachmentEntities" ] }, "id" : { "$ref" : "#/components/schemas/AttachmentEntitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesApplicationResourceAttribute" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttachmentEntitiesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentEntitiesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentEntitiesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttachmentEntitiesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentEntitiesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/attachmentEntities/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedManual_category_atResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsCategorizedResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttachmentsCategorizedResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachmentsCategorized)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachmentsCategorized" ] }, "id" : { "$ref" : "#/components/schemas/AttachmentsCategorizedIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedUser_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsCategorizedIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsCategorizedPassed_override_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsCategorizedLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AttachmentsCategorizedAttachment_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsCategorizedFile_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsCategorizedPhoto_categoryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsCategorizedResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "photo_category" : { "$ref" : "#/components/schemas/AttachmentsCategorizedPhoto_categoryResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/AttachmentsCategorizedAccount_numberResourceAttribute", "exampleSetFlag" : false }, "purpose" : { "$ref" : "#/components/schemas/AttachmentsCategorizedPurposeResourceAttribute", "exampleSetFlag" : false }, "file_name" : { "$ref" : "#/components/schemas/AttachmentsCategorizedFile_nameResourceAttribute", "exampleSetFlag" : false }, "probability" : { "$ref" : "#/components/schemas/AttachmentsCategorizedProbabilityResourceAttribute", "exampleSetFlag" : false }, "passed_override_at" : { "$ref" : "#/components/schemas/AttachmentsCategorizedPassed_override_atResourceAttribute", "exampleSetFlag" : false }, "manual_category" : { "$ref" : "#/components/schemas/AttachmentsCategorizedManual_categoryResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/AttachmentsCategorizedLonResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/AttachmentsCategorizedTicket_idResourceAttribute", "exampleSetFlag" : false }, "manual_category_by_id" : { "$ref" : "#/components/schemas/AttachmentsCategorizedManual_category_by_idResourceAttribute", "exampleSetFlag" : false }, "customer_facility_type" : { "$ref" : "#/components/schemas/AttachmentsCategorizedCustomer_facility_typeResourceAttribute", "exampleSetFlag" : false }, "manual_category_at" : { "$ref" : "#/components/schemas/AttachmentsCategorizedManual_category_atResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/AttachmentsCategorizedUser_idResourceAttribute", "exampleSetFlag" : false }, "generated_at" : { "$ref" : "#/components/schemas/AttachmentsCategorizedGenerated_atResourceAttribute", "exampleSetFlag" : false }, "received_at" : { "$ref" : "#/components/schemas/AttachmentsCategorizedReceived_atResourceAttribute", "exampleSetFlag" : false }, "attachment_id" : { "$ref" : "#/components/schemas/AttachmentsCategorizedAttachment_idResourceAttribute", "exampleSetFlag" : false }, "passed" : { "$ref" : "#/components/schemas/AttachmentsCategorizedPassedResourceAttribute", "exampleSetFlag" : false }, "passed_override_by_id" : { "$ref" : "#/components/schemas/AttachmentsCategorizedPassed_override_by_idResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/AttachmentsCategorizedLatResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachmentsCategorized/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachmentsCategorized/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedGenerated_atResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsCategorizedPassedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "AttachmentsCategorizedManual_category_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsCategorizedTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsCategorizedResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachmentsCategorized/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsCategorizedLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AttachmentsCategorizedPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentsCategorizedPostResourceReference", "exampleSetFlag" : false } ] }, "AttachmentsCategorizedTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttachmentsCategorizedResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachmentsCategorized)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachmentsCategorized" ] }, "id" : { "$ref" : "#/components/schemas/AttachmentsCategorizedIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttachmentsCategorizedManual_categoryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsCategorizedPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentsCategorizedPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedReceived_atResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsCategorizedPassed_override_atResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsCategorizedPurposeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsCategorizedResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceLinks", "exampleSetFlag" : false } ] }, "AttachmentsCategorizedPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsCategorizedPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsCategorizedProbabilityResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AttachmentsCategorizedCustomer_facility_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsWithNotificationsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsAttachment_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsWithNotificationsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachmentsWithNotifications/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsStatusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsWithNotificationsAttachment_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsWithNotificationsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceLinks", "exampleSetFlag" : false } ] }, "AttachmentsWithNotificationsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachmentsWithNotifications)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachmentsWithNotifications" ] }, "id" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AttachmentsWithNotificationsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "original_ticket_number" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsOriginal_ticket_numberResourceAttribute", "exampleSetFlag" : false }, "created_time" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsCreated_timeResourceAttribute", "exampleSetFlag" : false }, "file_name" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsFile_nameResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsLonResourceAttribute", "exampleSetFlag" : false }, "entity_id" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsEntity_idResourceAttribute", "exampleSetFlag" : false }, "file_size" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsFile_sizeResourceAttribute", "exampleSetFlag" : false }, "attached_by" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsAttached_byResourceAttribute", "exampleSetFlag" : false }, "entity_kind" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsEntity_kindResourceAttribute", "exampleSetFlag" : false }, "attachment_type" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsAttachment_typeResourceAttribute", "exampleSetFlag" : false }, "when_attached" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsWhen_attachedResourceAttribute", "exampleSetFlag" : false }, "attachment_id" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsAttachment_idResourceAttribute", "exampleSetFlag" : false }, "created_date" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsCreated_dateResourceAttribute", "exampleSetFlag" : false }, "hash" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsHashResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsLatResourceAttribute", "exampleSetFlag" : false }, "when_uploaded" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsWhen_uploadedResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttachmentsWithNotificationsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttachmentsWithNotificationsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsAttached_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsWithNotificationsHashResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsWithNotificationsTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttachmentsWithNotificationsEntity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsWithNotificationsLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "AttachmentsWithNotificationsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachmentsWithNotifications/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachmentsWithNotifications/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentTag" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachmentsWithNotifications/{id}/relationships/attachmentTag" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachmentsWithNotifications/{id}/attachmentTag" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsWhen_attachedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsWithNotificationsWhen_uploadedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsWithNotificationsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attachmentsWithNotifications)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attachmentsWithNotifications" ] }, "id" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttachmentsWithNotificationsPostResourceReference", "exampleSetFlag" : false } ] }, "AttachmentsWithNotificationsFile_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsWithNotificationsCreated_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsWithNotificationsEntity_kindResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttachmentsWithNotificationsIdResourceAttribute" : { "type" : "object", "properties" : { "attachment_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "entity_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttachmentsWithNotificationsFile_sizeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsWithNotificationsAttachmentTagResourceAttribute" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttachmentsWithNotificationsCreated_timeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttachmentsWithNotificationsOriginal_ticket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttributeMappingsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAttribute" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetModel" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "quickCode" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetMake" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetType" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/AttributeMappingsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "AttributeMappingsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttributeMappingsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttributeMappingsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttributeMappingsResourceLinks", "exampleSetFlag" : false } ] }, "AttributeMappingsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttributeMappingsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttributeMappingsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttributeMappingsResourcePostRelationships", "exampleSetFlag" : false } ] }, "AttributeMappingsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttributeMappingsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attributeMappings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attributeMappings" ] }, "id" : { "$ref" : "#/components/schemas/AttributeMappingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "AttributeMappingsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttributeMappingsAttribute_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttributeMappingsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttributeMappingsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAttribute" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/relationships/assetAttribute" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/assetAttribute" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetModel" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/relationships/assetModel" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/assetModel" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "quickCode" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/relationships/quickCode" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/quickCode" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetMake" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/relationships/assetMake" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/assetMake" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetType" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/relationships/assetType" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}/assetType" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttributeMappingsAssetModelResourceAttribute" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttributeMappingsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (attributeMappings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "attributeMappings" ] }, "id" : { "$ref" : "#/components/schemas/AttributeMappingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsMake_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttributeMappingsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttributeMappingsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/attributeMappings/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/AttributeMappingsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttributeMappingsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttributeMappingsAssetTypeResourceAttribute" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttributeMappingsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AttributeMappingsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AttributeMappingsNotesResourceAttribute", "exampleSetFlag" : false }, "model_id" : { "$ref" : "#/components/schemas/AttributeMappingsModel_idResourceAttribute", "exampleSetFlag" : false }, "make_id" : { "$ref" : "#/components/schemas/AttributeMappingsMake_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttributeMappingsCreated_byResourceAttribute", "exampleSetFlag" : false }, "asset_type_id" : { "$ref" : "#/components/schemas/AttributeMappingsAsset_type_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AttributeMappingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "attribute_id" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AttributeMappingsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "quick_code_id" : { "$ref" : "#/components/schemas/AttributeMappingsQuick_code_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttributeMappingsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AttributeMappingsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AttributeMappingsNotesResourceAttribute", "exampleSetFlag" : false }, "model_id" : { "$ref" : "#/components/schemas/AttributeMappingsModel_idResourceAttribute", "exampleSetFlag" : false }, "make_id" : { "$ref" : "#/components/schemas/AttributeMappingsMake_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttributeMappingsCreated_byResourceAttribute", "exampleSetFlag" : false }, "asset_type_id" : { "$ref" : "#/components/schemas/AttributeMappingsAsset_type_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AttributeMappingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "attribute_id" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AttributeMappingsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttributeMappingsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "quick_code_id" : { "$ref" : "#/components/schemas/AttributeMappingsQuick_code_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsAssetMakeResourceAttribute" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttributeMappingsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AttributeMappingsNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttributeMappingsQuickCodeResourceAttribute" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "AttributeMappingsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAttribute" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetModel" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetModelsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "quickCode" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetMake" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetType" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsAsset_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttributeMappingsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/AttributeMappingsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/AttributeMappingsNotesResourceAttribute", "exampleSetFlag" : false }, "model_id" : { "$ref" : "#/components/schemas/AttributeMappingsModel_idResourceAttribute", "exampleSetFlag" : false }, "make_id" : { "$ref" : "#/components/schemas/AttributeMappingsMake_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/AttributeMappingsCreated_byResourceAttribute", "exampleSetFlag" : false }, "asset_type_id" : { "$ref" : "#/components/schemas/AttributeMappingsAsset_type_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/AttributeMappingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/AttributeMappingsCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute_id" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/AttributeMappingsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/AttributeMappingsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/AttributeMappingsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "quick_code_id" : { "$ref" : "#/components/schemas/AttributeMappingsQuick_code_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsQuick_code_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttributeMappingsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "AttributeMappingsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttributeMappingsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/AttributeMappingsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsModel_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "AttributeMappingsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "AttributeMappingsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "AttributeMappingsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "AttributeMappingsAssetAttributeResourceAttribute" : { "$ref" : "#/components/schemas/AssetAttributesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "BillableCustomersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "BillableCustomersDays_to_send_reportResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BillableCustomersCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "BillableCustomersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/BillableCustomersEnd_dateResourceAttribute", "exampleSetFlag" : false }, "contract_id" : { "$ref" : "#/components/schemas/BillableCustomersContract_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/BillableCustomersActiveResourceAttribute", "exampleSetFlag" : false }, "inv_photos_required" : { "$ref" : "#/components/schemas/BillableCustomersInv_photos_requiredResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/BillableCustomersCreated_byResourceAttribute", "exampleSetFlag" : false }, "notified_by_category_id" : { "$ref" : "#/components/schemas/BillableCustomersNotified_by_category_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/BillableCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "days_to_send_report" : { "$ref" : "#/components/schemas/BillableCustomersDays_to_send_reportResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/BillableCustomersUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/BillableCustomersFacility_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by_id" : { "$ref" : "#/components/schemas/BillableCustomersLast_updated_by_idResourceAttribute", "exampleSetFlag" : false }, "not_billable" : { "$ref" : "#/components/schemas/BillableCustomersNot_billableResourceAttribute", "exampleSetFlag" : false }, "state_id" : { "$ref" : "#/components/schemas/BillableCustomersState_idResourceAttribute", "exampleSetFlag" : false }, "billable_customers_group_id" : { "$ref" : "#/components/schemas/BillableCustomersBillable_customers_group_idResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/BillableCustomersCustomer_idResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/BillableCustomersStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BillableCustomersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "BillableCustomersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BillableCustomersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "BillableCustomersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "lastUpdatedBy" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/relationships/lastUpdatedBy" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/lastUpdatedBy" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "createdBy" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/relationships/createdBy" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/createdBy" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsCustomer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/relationships/cmsCustomer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/cmsCustomer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "state" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/relationships/state" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/state" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "facility" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/relationships/facility" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}/facility" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FacilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FacilitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersContract_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "BillableCustomersStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "BillableCustomersBillable_customers_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BillableCustomersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/BillableCustomersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (billableCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "billableCustomers" ] }, "id" : { "$ref" : "#/components/schemas/BillableCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/BillableCustomersEnd_dateResourceAttribute", "exampleSetFlag" : false }, "contract_id" : { "$ref" : "#/components/schemas/BillableCustomersContract_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/BillableCustomersActiveResourceAttribute", "exampleSetFlag" : false }, "inv_photos_required" : { "$ref" : "#/components/schemas/BillableCustomersInv_photos_requiredResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/BillableCustomersCreated_byResourceAttribute", "exampleSetFlag" : false }, "notified_by_category_id" : { "$ref" : "#/components/schemas/BillableCustomersNotified_by_category_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/BillableCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "days_to_send_report" : { "$ref" : "#/components/schemas/BillableCustomersDays_to_send_reportResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/BillableCustomersUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/BillableCustomersFacility_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by_id" : { "$ref" : "#/components/schemas/BillableCustomersLast_updated_by_idResourceAttribute", "exampleSetFlag" : false }, "not_billable" : { "$ref" : "#/components/schemas/BillableCustomersNot_billableResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/BillableCustomersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state_id" : { "$ref" : "#/components/schemas/BillableCustomersState_idResourceAttribute", "exampleSetFlag" : false }, "billable_customers_group_id" : { "$ref" : "#/components/schemas/BillableCustomersBillable_customers_group_idResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/BillableCustomersCustomer_idResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/BillableCustomersStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "BillableCustomersNotified_by_category_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BillableCustomersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/BillableCustomersEnd_dateResourceAttribute", "exampleSetFlag" : false }, "contract_id" : { "$ref" : "#/components/schemas/BillableCustomersContract_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/BillableCustomersActiveResourceAttribute", "exampleSetFlag" : false }, "inv_photos_required" : { "$ref" : "#/components/schemas/BillableCustomersInv_photos_requiredResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/BillableCustomersCreated_byResourceAttribute", "exampleSetFlag" : false }, "notified_by_category_id" : { "$ref" : "#/components/schemas/BillableCustomersNotified_by_category_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/BillableCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "days_to_send_report" : { "$ref" : "#/components/schemas/BillableCustomersDays_to_send_reportResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/BillableCustomersUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/BillableCustomersCreated_onResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/BillableCustomersFacility_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by_id" : { "$ref" : "#/components/schemas/BillableCustomersLast_updated_by_idResourceAttribute", "exampleSetFlag" : false }, "not_billable" : { "$ref" : "#/components/schemas/BillableCustomersNot_billableResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/BillableCustomersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state_id" : { "$ref" : "#/components/schemas/BillableCustomersState_idResourceAttribute", "exampleSetFlag" : false }, "billable_customers_group_id" : { "$ref" : "#/components/schemas/BillableCustomersBillable_customers_group_idResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/BillableCustomersCustomer_idResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/BillableCustomersStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/BillableCustomersResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersInv_photos_requiredResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BillableCustomersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/billableCustomers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/BillableCustomersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "BillableCustomersLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "BillableCustomersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (billableCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "billableCustomers" ] }, "id" : { "$ref" : "#/components/schemas/BillableCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BillableCustomersLast_updated_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BillableCustomersUtility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BillableCustomersCmsCustomerResourceAttribute" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "BillableCustomersCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "BillableCustomersFacility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BillableCustomersCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BillableCustomersNot_billableResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "BillableCustomersLastUpdatedByResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "BillableCustomersCreatedByResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "BillableCustomersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/BillableCustomersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/BillableCustomersResourcePostAttributes", "exampleSetFlag" : false } ] }, "BillableCustomersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BillableCustomersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/BillableCustomersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/BillableCustomersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/BillableCustomersResourceLinks", "exampleSetFlag" : false } ] }, "BillableCustomersFacilityResourceAttribute" : { "$ref" : "#/components/schemas/FacilitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "BillableCustomersStateResourceAttribute" : { "$ref" : "#/components/schemas/StatesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "BillableCustomersState_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BucketsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (buckets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "buckets" ] }, "id" : { "$ref" : "#/components/schemas/BucketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsScreeningResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "BucketsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/BucketsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/BucketsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/BucketsResourceLinks", "exampleSetFlag" : false } ] }, "BucketsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BucketsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "BucketsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/BucketsPostResourceReference", "exampleSetFlag" : false } ] }, "BucketsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BucketsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/buckets/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsUser_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BucketsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (buckets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "buckets" ] }, "id" : { "$ref" : "#/components/schemas/BucketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "screening" : { "$ref" : "#/components/schemas/BucketsScreeningResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/BucketsUser_idResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/BucketsNameResourceAttribute", "exampleSetFlag" : false }, "translore" : { "$ref" : "#/components/schemas/BucketsTransloreResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "BucketsLocatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "BucketsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "usr" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/buckets/{id}/relationships/usr" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/buckets/{id}/usr" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/buckets/{id}/relationships/locates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/buckets/{id}/locates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "BucketsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/BucketsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "BucketsTransloreResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "BucketsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/BucketsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "BucketsUsrResourceAttribute" : { "$ref" : "#/components/schemas/UsrsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CasesSubtypesCasesTypeResourceAttribute" : { "$ref" : "#/components/schemas/CasesTypesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CasesSubtypesCases_sub_type_descriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CasesSubtypesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cases_type_id" : { "$ref" : "#/components/schemas/CasesSubtypesCases_type_idResourceAttribute", "exampleSetFlag" : false }, "cases_sub_type_description" : { "$ref" : "#/components/schemas/CasesSubtypesCases_sub_type_descriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CasesSubtypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CasesSubtypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesSubtypes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesSubtypesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesSubtypesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesSubtypesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesSubtypesResourceLinks", "exampleSetFlag" : false } ] }, "CasesSubtypesLegalCasesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CasesSubtypesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CasesSubtypesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesCases_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CasesSubtypesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CasesSubtypesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CasesSubtypesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CasesSubtypesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CasesSubtypesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CasesSubtypesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesSubtypesResourcePostAttributes", "exampleSetFlag" : false } ] }, "CasesSubtypesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cases_type_id" : { "$ref" : "#/components/schemas/CasesSubtypesCases_type_idResourceAttribute", "exampleSetFlag" : false }, "cases_sub_type_description" : { "$ref" : "#/components/schemas/CasesSubtypesCases_sub_type_descriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CasesSubtypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CasesSubtypesCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CasesSubtypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CasesSubtypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "legalCases" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesSubtypes/{id}/relationships/legalCases" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesSubtypes/{id}/legalCases" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "casesType" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesSubtypes/{id}/relationships/casesType" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesSubtypes/{id}/casesType" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CasesTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (casesSubtypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "casesSubtypes" ] }, "id" : { "$ref" : "#/components/schemas/CasesSubtypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CasesSubtypesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CasesSubtypesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cases_type_id" : { "$ref" : "#/components/schemas/CasesSubtypesCases_type_idResourceAttribute", "exampleSetFlag" : false }, "cases_sub_type_description" : { "$ref" : "#/components/schemas/CasesSubtypesCases_sub_type_descriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CasesSubtypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CasesSubtypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CasesSubtypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CasesSubtypesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesSubtypesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesSubtypesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesSubtypesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CasesSubtypesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (casesSubtypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "casesSubtypes" ] }, "id" : { "$ref" : "#/components/schemas/CasesSubtypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesCasesSubtypesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CasesTypesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CasesTypesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesTypesResourcePostAttributes", "exampleSetFlag" : false } ] }, "CasesTypesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CasesTypesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CasesTypesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "legalCases" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesTypes/{id}/relationships/legalCases" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesTypes/{id}/legalCases" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "casesSubtypes" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesTypes/{id}/relationships/casesSubtypes" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesTypes/{id}/casesSubtypes" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesTypesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CasesTypesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CasesTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesTypesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesTypesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/casesTypes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CasesTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesTypesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesTypesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CasesTypesResourceLinks", "exampleSetFlag" : false } ] }, "CasesTypesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (casesTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "casesTypes" ] }, "id" : { "$ref" : "#/components/schemas/CasesTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesLegalCasesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CasesTypesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CasesTypesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CasesTypesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CasesTypesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CasesTypesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CasesTypesCases_type_descriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CasesTypesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cases_type_description" : { "$ref" : "#/components/schemas/CasesTypesCases_type_descriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CasesTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CasesTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CasesTypesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CasesTypesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cases_type_description" : { "$ref" : "#/components/schemas/CasesTypesCases_type_descriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CasesTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CasesTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CasesTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (casesTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "casesTypes" ] }, "id" : { "$ref" : "#/components/schemas/CasesTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CasesTypesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cases_type_description" : { "$ref" : "#/components/schemas/CasesTypesCases_type_descriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CasesTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CasesTypesCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CasesTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CasesTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CategoryTypeMakeMappingsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceLinks", "exampleSetFlag" : false } ] }, "CategoryTypeMakeMappingsAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CategoryTypeMakeMappingsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "type_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsType_idResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsDescriptionResourceAttribute", "exampleSetFlag" : false }, "make_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsMake_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "category_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCategory_idResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "category_type_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCategory_type_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsAssetCategoryTypeResourceAttribute" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CategoryTypeMakeMappingsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (categoryTypeMakeMappings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "categoryTypeMakeMappings" ] }, "id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CategoryTypeMakeMappingsAssetCategoryResourceAttribute" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CategoryTypeMakeMappingsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "type_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsType_idResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsDescriptionResourceAttribute", "exampleSetFlag" : false }, "make_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsMake_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "category_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCategory_idResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "category_type_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCategory_type_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CategoryTypeMakeMappingsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CategoryTypeMakeMappingsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CategoryTypeMakeMappingsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CategoryTypeMakeMappingsAssetMakeResourceAttribute" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CategoryTypeMakeMappingsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetCategory" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetMake" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetType" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetCategoryType" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (categoryTypeMakeMappings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "categoryTypeMakeMappings" ] }, "id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CategoryTypeMakeMappingsCategory_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CategoryTypeMakeMappingsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetCategory" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetMake" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetType" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetCategoryType" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CategoryTypeMakeMappingsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CategoryTypeMakeMappingsCategory_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CategoryTypeMakeMappingsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourcePostRelationships", "exampleSetFlag" : false } ] }, "CategoryTypeMakeMappingsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CategoryTypeMakeMappingsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsType_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CategoryTypeMakeMappingsMake_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CategoryTypeMakeMappingsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CategoryTypeMakeMappingsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CategoryTypeMakeMappingsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetCategory" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assetCategory" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assetCategory" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetCategoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetMake" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assetMake" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assetMake" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetMakesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetType" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assetType" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assetType" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assetCategoryType" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/relationships/assetCategoryType" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/categoryTypeMakeMappings/{id}/assetCategoryType" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CategoryTypeMakeMappingsAssetTypeResourceAttribute" : { "$ref" : "#/components/schemas/AssetTypesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CategoryTypeMakeMappingsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "type_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsType_idResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsDescriptionResourceAttribute", "exampleSetFlag" : false }, "make_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsMake_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "category_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCategory_idResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "category_type_id" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsCategory_type_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CategoryTypeMakeMappingsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CategoryTypeMakeMappingsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ChangeLogsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "asset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/changeLogs/{id}/relationships/asset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/changeLogs/{id}/asset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ChangeLogsOld_valueResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ChangeLogsActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ChangeLogsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ChangeLogsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ChangeLogsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ChangeLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ChangeLogsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ChangeLogsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ChangeLogsFieldnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ChangeLogsReference_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ChangeLogsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ChangeLogsPostResourceReference", "exampleSetFlag" : false } ] }, "ChangeLogsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ChangeLogsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/changeLogs/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ChangeLogsTypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ChangeLogsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ChangeLogsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ChangeLogsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ChangeLogsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ChangeLogsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ChangeLogsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ChangeLogsResourceLinks", "exampleSetFlag" : false } ] }, "ChangeLogsIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "ChangeLogsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ChangeLogsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ChangeLogsAsset_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ChangeLogsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "fieldname" : { "$ref" : "#/components/schemas/ChangeLogsFieldnameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ChangeLogsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "reference_id" : { "$ref" : "#/components/schemas/ChangeLogsReference_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/ChangeLogsActiveResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/ChangeLogsVersion_numberResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ChangeLogsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "old_value" : { "$ref" : "#/components/schemas/ChangeLogsOld_valueResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/ChangeLogsAsset_idResourceAttribute", "exampleSetFlag" : false }, "type" : { "$ref" : "#/components/schemas/ChangeLogsTypeResourceAttribute", "exampleSetFlag" : false }, "new_value" : { "$ref" : "#/components/schemas/ChangeLogsNew_valueResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ChangeLogsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (changeLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "changeLogs" ] }, "id" : { "$ref" : "#/components/schemas/ChangeLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ChangeLogsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ChangeLogsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ChangeLogsNew_valueResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ChangeLogsAssetResourceAttribute" : { "$ref" : "#/components/schemas/AssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ChangeLogsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ChangeLogsVersion_numberResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ChangeLogsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (changeLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "changeLogs" ] }, "id" : { "$ref" : "#/components/schemas/ChangeLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ChangeLogsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ChangeLogsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ClaimAllocationTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "type_allocation_name" : { "$ref" : "#/components/schemas/ClaimAllocationTypesType_allocation_nameResourceAttribute", "exampleSetFlag" : false }, "claim_category_id" : { "$ref" : "#/components/schemas/ClaimAllocationTypesClaim_category_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimAllocationTypesCreated_byResourceAttribute", "exampleSetFlag" : false }, "seq" : { "$ref" : "#/components/schemas/ClaimAllocationTypesSeqResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceLinks", "exampleSetFlag" : false } ] }, "ClaimAllocationTypesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimAllocationTypesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimAllocationTypesResourcePostAttributes", "exampleSetFlag" : false } ] }, "ClaimAllocationTypesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimAllocationTypesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimAllocationTypesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ClaimAllocationTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "type_allocation_name" : { "$ref" : "#/components/schemas/ClaimAllocationTypesType_allocation_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimAllocationTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "claim_category_id" : { "$ref" : "#/components/schemas/ClaimAllocationTypesClaim_category_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimAllocationTypesCreated_byResourceAttribute", "exampleSetFlag" : false }, "seq" : { "$ref" : "#/components/schemas/ClaimAllocationTypesSeqResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "claimCategory" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimAllocationTypes/{id}/relationships/claimCategory" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimAllocationTypes/{id}/claimCategory" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimAllocationTypesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ClaimAllocationTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "type_allocation_name" : { "$ref" : "#/components/schemas/ClaimAllocationTypesType_allocation_nameResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ClaimAllocationTypesCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimAllocationTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "claim_category_id" : { "$ref" : "#/components/schemas/ClaimAllocationTypesClaim_category_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimAllocationTypesCreated_byResourceAttribute", "exampleSetFlag" : false }, "seq" : { "$ref" : "#/components/schemas/ClaimAllocationTypesSeqResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimAllocationTypesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimAllocationTypesSeqResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimAllocationTypesType_allocation_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimAllocationTypesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimAllocationTypesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimAllocationTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimAllocationTypes" ] }, "id" : { "$ref" : "#/components/schemas/ClaimAllocationTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimAllocationTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimAllocationTypes" ] }, "id" : { "$ref" : "#/components/schemas/ClaimAllocationTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesClaim_category_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimAllocationTypesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimAllocationTypesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimAllocationTypes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimAllocationTypesClaimCategoryResourceAttribute" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimAllocationTypesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimAllocationTypesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ClaimAllocationTypesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ClaimCategoriesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ClaimCategoriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "claim_category_name" : { "$ref" : "#/components/schemas/ClaimCategoriesClaim_category_nameResourceAttribute", "exampleSetFlag" : false }, "claim_category_type" : { "$ref" : "#/components/schemas/ClaimCategoriesClaim_category_typeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimCategoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimCategoriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "claimAllocationTypes" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimCategories/{id}/relationships/claimAllocationTypes" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimCategories/{id}/claimAllocationTypes" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claims" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimCategories/{id}/relationships/claims" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimCategories/{id}/claims" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claimSpendCategories" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimCategories/{id}/relationships/claimSpendCategories" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimCategories/{id}/claimSpendCategories" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimCategories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimCategories" ] }, "id" : { "$ref" : "#/components/schemas/ClaimCategoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimCategoriesClaimSpendCategoriesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ClaimCategoriesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimCategoriesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimCategoriesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimCategoriesResourcePostAttributes", "exampleSetFlag" : false } ] }, "ClaimCategoriesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimCategoriesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimCategoriesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimCategoriesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimCategoriesResourceLinks", "exampleSetFlag" : false } ] }, "ClaimCategoriesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ClaimCategoriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "claim_category_name" : { "$ref" : "#/components/schemas/ClaimCategoriesClaim_category_nameResourceAttribute", "exampleSetFlag" : false }, "claim_category_type" : { "$ref" : "#/components/schemas/ClaimCategoriesClaim_category_typeResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ClaimCategoriesCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimCategoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimCategoriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimCategories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimCategories" ] }, "id" : { "$ref" : "#/components/schemas/ClaimCategoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesClaim_category_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimCategoriesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimCategoriesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimCategoriesClaimAllocationTypesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ClaimCategoriesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimCategories/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimCategoriesClaimsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ClaimCategoriesClaim_category_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimCategoriesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimCategoriesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ClaimCategoriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "claim_category_name" : { "$ref" : "#/components/schemas/ClaimCategoriesClaim_category_nameResourceAttribute", "exampleSetFlag" : false }, "claim_category_type" : { "$ref" : "#/components/schemas/ClaimCategoriesClaim_category_typeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimCategoriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimCategoriesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimCategoriesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ClaimCategoriesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ClaimDetailsCase_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsAccruedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ClaimDetailsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDetails/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDetails/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDetails/{id}/relationships/investigationDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDetails/{id}/investigationDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalCase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDetails/{id}/relationships/legalCase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDetails/{id}/legalCase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claim" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDetails/{id}/relationships/claim" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDetails/{id}/claim" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimDetailsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimDetails)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimDetails" ] }, "id" : { "$ref" : "#/components/schemas/ClaimDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsClaim_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsEstimate_variance_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimDetailsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ClaimDetailsDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimDetailsLegalCaseResourceAttribute" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimDetailsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDetails/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "estimate_variance_reason_id" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_variance_reason_idResourceAttribute", "exampleSetFlag" : false }, "estimate_accrued_amount" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_accrued_amountResourceAttribute", "exampleSetFlag" : false }, "estimate_id" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_idResourceAttribute", "exampleSetFlag" : false }, "claim_id" : { "$ref" : "#/components/schemas/ClaimDetailsClaim_idResourceAttribute", "exampleSetFlag" : false }, "payment_amount" : { "$ref" : "#/components/schemas/ClaimDetailsPayment_amountResourceAttribute", "exampleSetFlag" : false }, "retain_accrual_balance" : { "$ref" : "#/components/schemas/ClaimDetailsRetain_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimDetailsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimDetailsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/ClaimDetailsUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "estimate_version_number" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_version_numberResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/ClaimDetailsInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/ClaimDetailsAccruedResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/ClaimDetailsCase_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/ClaimDetailsFacility_idResourceAttribute", "exampleSetFlag" : false }, "accrued_amount" : { "$ref" : "#/components/schemas/ClaimDetailsAccrued_amountResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/ClaimDetailsFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "estimate_accrued_balance" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_accrued_balanceResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/ClaimDetailsDamage_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsPayment_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimDetailsEstimate_accrued_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimDetailsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "estimate_variance_reason_id" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_variance_reason_idResourceAttribute", "exampleSetFlag" : false }, "estimate_accrued_amount" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_accrued_amountResourceAttribute", "exampleSetFlag" : false }, "estimate_id" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_idResourceAttribute", "exampleSetFlag" : false }, "claim_id" : { "$ref" : "#/components/schemas/ClaimDetailsClaim_idResourceAttribute", "exampleSetFlag" : false }, "payment_amount" : { "$ref" : "#/components/schemas/ClaimDetailsPayment_amountResourceAttribute", "exampleSetFlag" : false }, "retain_accrual_balance" : { "$ref" : "#/components/schemas/ClaimDetailsRetain_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimDetailsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimDetailsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/ClaimDetailsUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "estimate_version_number" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_version_numberResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/ClaimDetailsInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/ClaimDetailsAccruedResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/ClaimDetailsCase_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/ClaimDetailsFacility_idResourceAttribute", "exampleSetFlag" : false }, "accrued_amount" : { "$ref" : "#/components/schemas/ClaimDetailsAccrued_amountResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/ClaimDetailsFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "estimate_accrued_balance" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_accrued_balanceResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/ClaimDetailsDamage_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsEstimate_version_numberResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimDetailsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsFacility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsUtility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsRetain_accrual_balanceResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ClaimDetailsInvestigation_detail_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimDetailsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDetailsResourcePostAttributes", "exampleSetFlag" : false } ] }, "ClaimDetailsEstimate_accrued_balanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimDetailsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimDetailsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsDamage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsAccrued_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimDetailsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDetailsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsClaimResourceAttribute" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimDetailsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ClaimDetailsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimDetailsFacility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsEstimate_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDetailsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "estimate_variance_reason_id" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_variance_reason_idResourceAttribute", "exampleSetFlag" : false }, "estimate_accrued_amount" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_accrued_amountResourceAttribute", "exampleSetFlag" : false }, "estimate_id" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_idResourceAttribute", "exampleSetFlag" : false }, "claim_id" : { "$ref" : "#/components/schemas/ClaimDetailsClaim_idResourceAttribute", "exampleSetFlag" : false }, "payment_amount" : { "$ref" : "#/components/schemas/ClaimDetailsPayment_amountResourceAttribute", "exampleSetFlag" : false }, "retain_accrual_balance" : { "$ref" : "#/components/schemas/ClaimDetailsRetain_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimDetailsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimDetailsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/ClaimDetailsUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ClaimDetailsCreated_onResourceAttribute", "exampleSetFlag" : false }, "estimate_version_number" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_version_numberResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/ClaimDetailsInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/ClaimDetailsAccruedResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/ClaimDetailsCase_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/ClaimDetailsFacility_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimDetailsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "accrued_amount" : { "$ref" : "#/components/schemas/ClaimDetailsAccrued_amountResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/ClaimDetailsFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "estimate_accrued_balance" : { "$ref" : "#/components/schemas/ClaimDetailsEstimate_accrued_balanceResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/ClaimDetailsDamage_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDetailsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDetailsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDetailsResourceLinks", "exampleSetFlag" : false } ] }, "ClaimDetailsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimDetailsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimDetails)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimDetails" ] }, "id" : { "$ref" : "#/components/schemas/ClaimDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDetailsInvestigationDetailResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimDetailsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ClaimDiscountsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "discount_amount" : { "$ref" : "#/components/schemas/ClaimDiscountsDiscount_amountResourceAttribute", "exampleSetFlag" : false }, "claim_id" : { "$ref" : "#/components/schemas/ClaimDiscountsClaim_idResourceAttribute", "exampleSetFlag" : false }, "discount_reason" : { "$ref" : "#/components/schemas/ClaimDiscountsDiscount_reasonResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimDiscountsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDiscountsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDiscounts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimDiscountsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDiscountsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimDiscountsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimDiscountsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimDiscountsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimDiscounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimDiscounts" ] }, "id" : { "$ref" : "#/components/schemas/ClaimDiscountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsClaimResourceAttribute" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimDiscountsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ClaimDiscountsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "claim" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDiscounts/{id}/relationships/claim" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimDiscounts/{id}/claim" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimDiscountsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDiscountsResourcePostAttributes", "exampleSetFlag" : false } ] }, "ClaimDiscountsDiscount_reasonResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDiscountsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimDiscounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimDiscounts" ] }, "id" : { "$ref" : "#/components/schemas/ClaimDiscountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimDiscountsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ClaimDiscountsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "discount_amount" : { "$ref" : "#/components/schemas/ClaimDiscountsDiscount_amountResourceAttribute", "exampleSetFlag" : false }, "claim_id" : { "$ref" : "#/components/schemas/ClaimDiscountsClaim_idResourceAttribute", "exampleSetFlag" : false }, "discount_reason" : { "$ref" : "#/components/schemas/ClaimDiscountsDiscount_reasonResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimDiscountsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimDiscountsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimDiscountsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDiscountsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDiscountsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimDiscountsResourceLinks", "exampleSetFlag" : false } ] }, "ClaimDiscountsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ClaimDiscountsDiscount_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimDiscountsClaim_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDiscountsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimDiscountsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ClaimDiscountsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ClaimDiscountsCreated_onResourceAttribute", "exampleSetFlag" : false }, "discount_amount" : { "$ref" : "#/components/schemas/ClaimDiscountsDiscount_amountResourceAttribute", "exampleSetFlag" : false }, "claim_id" : { "$ref" : "#/components/schemas/ClaimDiscountsClaim_idResourceAttribute", "exampleSetFlag" : false }, "discount_reason" : { "$ref" : "#/components/schemas/ClaimDiscountsDiscount_reasonResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimDiscountsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimDiscountsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimDiscountsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimDiscountsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimPayeesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimPayees/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimPayeesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimPayeesResourcePostAttributes", "exampleSetFlag" : false } ] }, "ClaimPayeesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimPayees)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimPayees" ] }, "id" : { "$ref" : "#/components/schemas/ClaimPayeesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/ClaimPayeesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimPayeesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ClaimPayeesCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/ClaimPayeesLast_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimPayeesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/ClaimPayeesCustomer_idResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/ClaimPayeesFirst_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimPayeesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/ClaimPayeesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ClaimPayeesFirst_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimPayeesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "cmsCustomer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimPayees/{id}/relationships/cmsCustomer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimPayees/{id}/cmsCustomer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimPayeesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ClaimPayeesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimPayeesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimPayeesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimPayeesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimPayeesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimPayeesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimPayeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimPayeesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimPayeesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesCmsCustomerResourceAttribute" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimPayeesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimPayeesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimPayeesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimPayeesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimPayeesResourceLinks", "exampleSetFlag" : false } ] }, "ClaimPayeesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/ClaimPayeesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimPayeesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/ClaimPayeesLast_nameResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/ClaimPayeesCustomer_idResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/ClaimPayeesFirst_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimPayeesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/ClaimPayeesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/ClaimPayeesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimPayeesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/ClaimPayeesLast_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimPayeesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/ClaimPayeesCustomer_idResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/ClaimPayeesFirst_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimPayeesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/ClaimPayeesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimPayeesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimPayeesEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ClaimPayeesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimPayees)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimPayees" ] }, "id" : { "$ref" : "#/components/schemas/ClaimPayeesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimPayeesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimPayeesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimPayeesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ClaimPayeesLast_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimSpendCategoriesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ClaimSpendCategoriesFacility_damage_relatedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ClaimSpendCategoriesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimSpendCategories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimSpendCategories" ] }, "id" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claimSpendCategories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claimSpendCategories" ] }, "id" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceLinks", "exampleSetFlag" : false } ] }, "ClaimSpendCategoriesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimSpendCategoriesClaim_category_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimSpendCategoriesInclude_pl_rp_paidResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ClaimSpendCategoriesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ClaimSpendCategoriesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimSpendCategoriesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourcePostAttributes", "exampleSetFlag" : false } ] }, "ClaimSpendCategoriesClaimsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ClaimSpendCategoriesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "claims" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimSpendCategories/{id}/relationships/claims" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimSpendCategories/{id}/claims" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claimCategory" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimSpendCategories/{id}/relationships/claimCategory" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimSpendCategories/{id}/claimCategory" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "include_pl_rp_paid" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesInclude_pl_rp_paidResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "facility_damage_related" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesFacility_damage_relatedResourceAttribute", "exampleSetFlag" : false }, "wd_acct" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesWd_acctResourceAttribute", "exampleSetFlag" : false }, "spend_category" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesSpend_categoryResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "claim_category_id" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesClaim_category_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claimSpendCategories/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesSpend_categoryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimSpendCategoriesWd_acctResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimSpendCategoriesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "include_pl_rp_paid" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesInclude_pl_rp_paidResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "facility_damage_related" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesFacility_damage_relatedResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesCreated_onResourceAttribute", "exampleSetFlag" : false }, "wd_acct" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesWd_acctResourceAttribute", "exampleSetFlag" : false }, "spend_category" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesSpend_categoryResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "claim_category_id" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesClaim_category_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "include_pl_rp_paid" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesInclude_pl_rp_paidResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "facility_damage_related" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesFacility_damage_relatedResourceAttribute", "exampleSetFlag" : false }, "wd_acct" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesWd_acctResourceAttribute", "exampleSetFlag" : false }, "spend_category" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesSpend_categoryResourceAttribute", "exampleSetFlag" : false }, "claim_category_id" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesClaim_category_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimSpendCategoriesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimSpendCategoriesClaimCategoryResourceAttribute" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimSpendCategoriesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimSpendCategoriesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimSpendCategoriesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimsFinal_disposition_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsDispute_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "notes" : { "$ref" : "#/components/schemas/ClaimsNotesResourceAttribute", "exampleSetFlag" : false }, "original_claim_id" : { "$ref" : "#/components/schemas/ClaimsOriginal_claim_idResourceAttribute", "exampleSetFlag" : false }, "accrued_period_id" : { "$ref" : "#/components/schemas/ClaimsAccrued_period_idResourceAttribute", "exampleSetFlag" : false }, "dispute_reason_id" : { "$ref" : "#/components/schemas/ClaimsDispute_reason_idResourceAttribute", "exampleSetFlag" : false }, "att3_var" : { "$ref" : "#/components/schemas/ClaimsAtt3_varResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/ClaimsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/ClaimsApprovedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/ClaimsStatus_idResourceAttribute", "exampleSetFlag" : false }, "att1_int" : { "$ref" : "#/components/schemas/ClaimsAtt1_intResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/ClaimsCase_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "accrued_amount" : { "$ref" : "#/components/schemas/ClaimsAccrued_amountResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/ClaimsPeriod_idResourceAttribute", "exampleSetFlag" : false }, "invoice_number" : { "$ref" : "#/components/schemas/ClaimsInvoice_numberResourceAttribute", "exampleSetFlag" : false }, "att2_var" : { "$ref" : "#/components/schemas/ClaimsAtt2_varResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/ClaimsDamage_idResourceAttribute", "exampleSetFlag" : false }, "disputed" : { "$ref" : "#/components/schemas/ClaimsDisputedResourceAttribute", "exampleSetFlag" : false }, "should_cost_variance_id" : { "$ref" : "#/components/schemas/ClaimsShould_cost_variance_idResourceAttribute", "exampleSetFlag" : false }, "payment_amount" : { "$ref" : "#/components/schemas/ClaimsPayment_amountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimsCreated_byResourceAttribute", "exampleSetFlag" : false }, "docket_number" : { "$ref" : "#/components/schemas/ClaimsDocket_numberResourceAttribute", "exampleSetFlag" : false }, "approved_by" : { "$ref" : "#/components/schemas/ClaimsApproved_byResourceAttribute", "exampleSetFlag" : false }, "review_date" : { "$ref" : "#/components/schemas/ClaimsReview_dateResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ClaimsCreated_onResourceAttribute", "exampleSetFlag" : false }, "claim_payee_address_id" : { "$ref" : "#/components/schemas/ClaimsClaim_payee_address_idResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/ClaimsSearch_textResourceAttribute", "exampleSetFlag" : false }, "reviewed_by" : { "$ref" : "#/components/schemas/ClaimsReviewed_byResourceAttribute", "exampleSetFlag" : false }, "payment_request_date" : { "$ref" : "#/components/schemas/ClaimsPayment_request_dateResourceAttribute", "exampleSetFlag" : false }, "approved_date" : { "$ref" : "#/components/schemas/ClaimsApproved_dateResourceAttribute", "exampleSetFlag" : false }, "claim_category_id" : { "$ref" : "#/components/schemas/ClaimsClaim_category_idResourceAttribute", "exampleSetFlag" : false }, "invoice_amount" : { "$ref" : "#/components/schemas/ClaimsInvoice_amountResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/ClaimsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "invoice_date" : { "$ref" : "#/components/schemas/ClaimsInvoice_dateResourceAttribute", "exampleSetFlag" : false }, "final_disposition_id" : { "$ref" : "#/components/schemas/ClaimsFinal_disposition_idResourceAttribute", "exampleSetFlag" : false }, "claim_payee_id" : { "$ref" : "#/components/schemas/ClaimsClaim_payee_idResourceAttribute", "exampleSetFlag" : false }, "spend_category_id" : { "$ref" : "#/components/schemas/ClaimsSpend_category_idResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/ClaimsCompleted_byResourceAttribute", "exampleSetFlag" : false }, "wd_supplier_invoice_reference" : { "$ref" : "#/components/schemas/ClaimsWd_supplier_invoice_referenceResourceAttribute", "exampleSetFlag" : false }, "invoice_receipt_date" : { "$ref" : "#/components/schemas/ClaimsInvoice_receipt_dateResourceAttribute", "exampleSetFlag" : false }, "att2_int" : { "$ref" : "#/components/schemas/ClaimsAtt2_intResourceAttribute", "exampleSetFlag" : false }, "cost_center_id" : { "$ref" : "#/components/schemas/ClaimsCost_center_idResourceAttribute", "exampleSetFlag" : false }, "payment_mode_id" : { "$ref" : "#/components/schemas/ClaimsPayment_mode_idResourceAttribute", "exampleSetFlag" : false }, "should_cost_estimate" : { "$ref" : "#/components/schemas/ClaimsShould_cost_estimateResourceAttribute", "exampleSetFlag" : false }, "att1_var" : { "$ref" : "#/components/schemas/ClaimsAtt1_varResourceAttribute", "exampleSetFlag" : false }, "retain_reserve_balance" : { "$ref" : "#/components/schemas/ClaimsRetain_reserve_balanceResourceAttribute", "exampleSetFlag" : false }, "att3_int" : { "$ref" : "#/components/schemas/ClaimsAtt3_intResourceAttribute", "exampleSetFlag" : false }, "settlement_pay_amount" : { "$ref" : "#/components/schemas/ClaimsSettlement_pay_amountResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/ClaimsAccruedResourceAttribute", "exampleSetFlag" : false }, "paid" : { "$ref" : "#/components/schemas/ClaimsPaidResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/ClaimsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/ClaimsRequest_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ClaimsSettlement_pay_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claims)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claims" ] }, "id" : { "$ref" : "#/components/schemas/ClaimsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ClaimsCompleted_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsOriginal_claim_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsPayment_mode_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsPayment_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimsPayeeAddressResourceAttribute" : { "$ref" : "#/components/schemas/PayeeAddressesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimsFinancialPeriodResourceAttribute" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsShould_cost_estimateResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimsAtt3_intResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "notes" : { "$ref" : "#/components/schemas/ClaimsNotesResourceAttribute", "exampleSetFlag" : false }, "original_claim_id" : { "$ref" : "#/components/schemas/ClaimsOriginal_claim_idResourceAttribute", "exampleSetFlag" : false }, "accrued_period_id" : { "$ref" : "#/components/schemas/ClaimsAccrued_period_idResourceAttribute", "exampleSetFlag" : false }, "dispute_reason_id" : { "$ref" : "#/components/schemas/ClaimsDispute_reason_idResourceAttribute", "exampleSetFlag" : false }, "att3_var" : { "$ref" : "#/components/schemas/ClaimsAtt3_varResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/ClaimsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/ClaimsApprovedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/ClaimsStatus_idResourceAttribute", "exampleSetFlag" : false }, "att1_int" : { "$ref" : "#/components/schemas/ClaimsAtt1_intResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/ClaimsCase_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ClaimsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "accrued_amount" : { "$ref" : "#/components/schemas/ClaimsAccrued_amountResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/ClaimsPeriod_idResourceAttribute", "exampleSetFlag" : false }, "invoice_number" : { "$ref" : "#/components/schemas/ClaimsInvoice_numberResourceAttribute", "exampleSetFlag" : false }, "att2_var" : { "$ref" : "#/components/schemas/ClaimsAtt2_varResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/ClaimsDamage_idResourceAttribute", "exampleSetFlag" : false }, "disputed" : { "$ref" : "#/components/schemas/ClaimsDisputedResourceAttribute", "exampleSetFlag" : false }, "should_cost_variance_id" : { "$ref" : "#/components/schemas/ClaimsShould_cost_variance_idResourceAttribute", "exampleSetFlag" : false }, "payment_amount" : { "$ref" : "#/components/schemas/ClaimsPayment_amountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimsCreated_byResourceAttribute", "exampleSetFlag" : false }, "docket_number" : { "$ref" : "#/components/schemas/ClaimsDocket_numberResourceAttribute", "exampleSetFlag" : false }, "approved_by" : { "$ref" : "#/components/schemas/ClaimsApproved_byResourceAttribute", "exampleSetFlag" : false }, "review_date" : { "$ref" : "#/components/schemas/ClaimsReview_dateResourceAttribute", "exampleSetFlag" : false }, "claim_payee_address_id" : { "$ref" : "#/components/schemas/ClaimsClaim_payee_address_idResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/ClaimsSearch_textResourceAttribute", "exampleSetFlag" : false }, "reviewed_by" : { "$ref" : "#/components/schemas/ClaimsReviewed_byResourceAttribute", "exampleSetFlag" : false }, "payment_request_date" : { "$ref" : "#/components/schemas/ClaimsPayment_request_dateResourceAttribute", "exampleSetFlag" : false }, "approved_date" : { "$ref" : "#/components/schemas/ClaimsApproved_dateResourceAttribute", "exampleSetFlag" : false }, "claim_category_id" : { "$ref" : "#/components/schemas/ClaimsClaim_category_idResourceAttribute", "exampleSetFlag" : false }, "invoice_amount" : { "$ref" : "#/components/schemas/ClaimsInvoice_amountResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/ClaimsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "invoice_date" : { "$ref" : "#/components/schemas/ClaimsInvoice_dateResourceAttribute", "exampleSetFlag" : false }, "final_disposition_id" : { "$ref" : "#/components/schemas/ClaimsFinal_disposition_idResourceAttribute", "exampleSetFlag" : false }, "claim_payee_id" : { "$ref" : "#/components/schemas/ClaimsClaim_payee_idResourceAttribute", "exampleSetFlag" : false }, "spend_category_id" : { "$ref" : "#/components/schemas/ClaimsSpend_category_idResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/ClaimsCompleted_byResourceAttribute", "exampleSetFlag" : false }, "wd_supplier_invoice_reference" : { "$ref" : "#/components/schemas/ClaimsWd_supplier_invoice_referenceResourceAttribute", "exampleSetFlag" : false }, "invoice_receipt_date" : { "$ref" : "#/components/schemas/ClaimsInvoice_receipt_dateResourceAttribute", "exampleSetFlag" : false }, "att2_int" : { "$ref" : "#/components/schemas/ClaimsAtt2_intResourceAttribute", "exampleSetFlag" : false }, "cost_center_id" : { "$ref" : "#/components/schemas/ClaimsCost_center_idResourceAttribute", "exampleSetFlag" : false }, "payment_mode_id" : { "$ref" : "#/components/schemas/ClaimsPayment_mode_idResourceAttribute", "exampleSetFlag" : false }, "should_cost_estimate" : { "$ref" : "#/components/schemas/ClaimsShould_cost_estimateResourceAttribute", "exampleSetFlag" : false }, "att1_var" : { "$ref" : "#/components/schemas/ClaimsAtt1_varResourceAttribute", "exampleSetFlag" : false }, "retain_reserve_balance" : { "$ref" : "#/components/schemas/ClaimsRetain_reserve_balanceResourceAttribute", "exampleSetFlag" : false }, "att3_int" : { "$ref" : "#/components/schemas/ClaimsAtt3_intResourceAttribute", "exampleSetFlag" : false }, "settlement_pay_amount" : { "$ref" : "#/components/schemas/ClaimsSettlement_pay_amountResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/ClaimsAccruedResourceAttribute", "exampleSetFlag" : false }, "paid" : { "$ref" : "#/components/schemas/ClaimsPaidResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/ClaimsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/ClaimsRequest_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsPayment_request_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ClaimsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsDisputedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ClaimsRetain_reserve_balanceResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ClaimsAtt3_varResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsInvoice_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimsAtt1_intResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsReview_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ClaimsApprovedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ClaimsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimsResourcePostAttributes", "exampleSetFlag" : false } ] }, "ClaimsAccruedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ClaimsWd_supplier_invoice_referenceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsInvoice_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ClaimsCustomerResourceAttribute" : { "$ref" : "#/components/schemas/CustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimsApproved_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsInvoice_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsInvoice_receipt_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ClaimsCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsCase_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsAccrued_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ClaimsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ClaimsSearch_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClaimsResourceLinks", "exampleSetFlag" : false } ] }, "ClaimsClaimDetailsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ClaimsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "claimDiscounts" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/relationships/claimDiscounts" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/claimDiscounts" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "payeeAddress" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/relationships/payeeAddress" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/payeeAddress" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PayeeAddressesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/PayeeAddressesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "financialPeriod" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/relationships/financialPeriod" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/financialPeriod" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claimDetails" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/relationships/claimDetails" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/claimDetails" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claimSpendCategory" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/relationships/claimSpendCategory" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/claimSpendCategory" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claimCategory" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/relationships/claimCategory" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/claimCategory" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/relationships/customer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}/customer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsAtt2_varResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsStatus_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsClaim_payee_address_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsClaim_category_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimsSpend_category_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsShould_cost_variance_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClaimsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/claims/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsReviewed_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsPeriod_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsCost_center_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsAccrued_period_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "notes" : { "$ref" : "#/components/schemas/ClaimsNotesResourceAttribute", "exampleSetFlag" : false }, "original_claim_id" : { "$ref" : "#/components/schemas/ClaimsOriginal_claim_idResourceAttribute", "exampleSetFlag" : false }, "accrued_period_id" : { "$ref" : "#/components/schemas/ClaimsAccrued_period_idResourceAttribute", "exampleSetFlag" : false }, "dispute_reason_id" : { "$ref" : "#/components/schemas/ClaimsDispute_reason_idResourceAttribute", "exampleSetFlag" : false }, "att3_var" : { "$ref" : "#/components/schemas/ClaimsAtt3_varResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/ClaimsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/ClaimsApprovedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ClaimsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/ClaimsStatus_idResourceAttribute", "exampleSetFlag" : false }, "att1_int" : { "$ref" : "#/components/schemas/ClaimsAtt1_intResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/ClaimsCase_idResourceAttribute", "exampleSetFlag" : false }, "accrued_amount" : { "$ref" : "#/components/schemas/ClaimsAccrued_amountResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/ClaimsPeriod_idResourceAttribute", "exampleSetFlag" : false }, "invoice_number" : { "$ref" : "#/components/schemas/ClaimsInvoice_numberResourceAttribute", "exampleSetFlag" : false }, "att2_var" : { "$ref" : "#/components/schemas/ClaimsAtt2_varResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/ClaimsDamage_idResourceAttribute", "exampleSetFlag" : false }, "disputed" : { "$ref" : "#/components/schemas/ClaimsDisputedResourceAttribute", "exampleSetFlag" : false }, "should_cost_variance_id" : { "$ref" : "#/components/schemas/ClaimsShould_cost_variance_idResourceAttribute", "exampleSetFlag" : false }, "payment_amount" : { "$ref" : "#/components/schemas/ClaimsPayment_amountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ClaimsCreated_byResourceAttribute", "exampleSetFlag" : false }, "docket_number" : { "$ref" : "#/components/schemas/ClaimsDocket_numberResourceAttribute", "exampleSetFlag" : false }, "approved_by" : { "$ref" : "#/components/schemas/ClaimsApproved_byResourceAttribute", "exampleSetFlag" : false }, "review_date" : { "$ref" : "#/components/schemas/ClaimsReview_dateResourceAttribute", "exampleSetFlag" : false }, "claim_payee_address_id" : { "$ref" : "#/components/schemas/ClaimsClaim_payee_address_idResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/ClaimsSearch_textResourceAttribute", "exampleSetFlag" : false }, "reviewed_by" : { "$ref" : "#/components/schemas/ClaimsReviewed_byResourceAttribute", "exampleSetFlag" : false }, "payment_request_date" : { "$ref" : "#/components/schemas/ClaimsPayment_request_dateResourceAttribute", "exampleSetFlag" : false }, "approved_date" : { "$ref" : "#/components/schemas/ClaimsApproved_dateResourceAttribute", "exampleSetFlag" : false }, "claim_category_id" : { "$ref" : "#/components/schemas/ClaimsClaim_category_idResourceAttribute", "exampleSetFlag" : false }, "invoice_amount" : { "$ref" : "#/components/schemas/ClaimsInvoice_amountResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/ClaimsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "invoice_date" : { "$ref" : "#/components/schemas/ClaimsInvoice_dateResourceAttribute", "exampleSetFlag" : false }, "final_disposition_id" : { "$ref" : "#/components/schemas/ClaimsFinal_disposition_idResourceAttribute", "exampleSetFlag" : false }, "claim_payee_id" : { "$ref" : "#/components/schemas/ClaimsClaim_payee_idResourceAttribute", "exampleSetFlag" : false }, "spend_category_id" : { "$ref" : "#/components/schemas/ClaimsSpend_category_idResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/ClaimsCompleted_byResourceAttribute", "exampleSetFlag" : false }, "wd_supplier_invoice_reference" : { "$ref" : "#/components/schemas/ClaimsWd_supplier_invoice_referenceResourceAttribute", "exampleSetFlag" : false }, "invoice_receipt_date" : { "$ref" : "#/components/schemas/ClaimsInvoice_receipt_dateResourceAttribute", "exampleSetFlag" : false }, "att2_int" : { "$ref" : "#/components/schemas/ClaimsAtt2_intResourceAttribute", "exampleSetFlag" : false }, "cost_center_id" : { "$ref" : "#/components/schemas/ClaimsCost_center_idResourceAttribute", "exampleSetFlag" : false }, "payment_mode_id" : { "$ref" : "#/components/schemas/ClaimsPayment_mode_idResourceAttribute", "exampleSetFlag" : false }, "should_cost_estimate" : { "$ref" : "#/components/schemas/ClaimsShould_cost_estimateResourceAttribute", "exampleSetFlag" : false }, "att1_var" : { "$ref" : "#/components/schemas/ClaimsAtt1_varResourceAttribute", "exampleSetFlag" : false }, "retain_reserve_balance" : { "$ref" : "#/components/schemas/ClaimsRetain_reserve_balanceResourceAttribute", "exampleSetFlag" : false }, "att3_int" : { "$ref" : "#/components/schemas/ClaimsAtt3_intResourceAttribute", "exampleSetFlag" : false }, "settlement_pay_amount" : { "$ref" : "#/components/schemas/ClaimsSettlement_pay_amountResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/ClaimsAccruedResourceAttribute", "exampleSetFlag" : false }, "paid" : { "$ref" : "#/components/schemas/ClaimsPaidResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/ClaimsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/ClaimsRequest_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsDocket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsDamage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (claims)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "claims" ] }, "id" : { "$ref" : "#/components/schemas/ClaimsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClaimsPaidResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ClaimsClaimSpendCategoryResourceAttribute" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClaimsApproved_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ClaimsAtt2_intResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ClaimsAtt1_varResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClaimsClaimDiscountsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ClaimsClaim_payee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsRequest_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClaimsClaimCategoryResourceAttribute" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ClosedTicketsIdResourceAttribute" : { "type" : "object", "properties" : { "account_number" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "contract_number" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/ClosedTicketsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/ClosedTicketsContract_numberResourceAttribute", "exampleSetFlag" : false }, "count" : { "$ref" : "#/components/schemas/ClosedTicketsCountResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClosedTicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ClosedTicketsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (closedTickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "closedTickets" ] }, "id" : { "$ref" : "#/components/schemas/ClosedTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClosedTicketsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClosedTicketsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClosedTicketsResourceLinks", "exampleSetFlag" : false } ] }, "ClosedTicketsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (closedTickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "closedTickets" ] }, "id" : { "$ref" : "#/components/schemas/ClosedTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "count" : { "$ref" : "#/components/schemas/ClosedTicketsCountResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClosedTicketsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClosedTicketsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClosedTicketsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ClosedTicketsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClosedTicketsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsContract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClosedTicketsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ClosedTicketsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ClosedTicketsResourcePostAttributes", "exampleSetFlag" : false } ] }, "ClosedTicketsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/closedTicket/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ClosedTicketsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "count" : { "$ref" : "#/components/schemas/ClosedTicketsCountResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ClosedTicketsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ClosedTicketsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ClosedTicketsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ClosedTicketsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClosedTicketsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsCustomersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersBillableCustomersResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsCustomersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsCustomersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsCustomersResourcePostAttributes", "exampleSetFlag" : false } ] }, "CmsCustomersEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CmsCustomersFlatRateCustomersResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsCustomersCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsCustomersActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "CmsCustomersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "active" : { "$ref" : "#/components/schemas/CmsCustomersActiveResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersInvestigationDetailsVersionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsCustomersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsCustomersResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersDamageCustomersResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsCustomersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsCustomersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "damageCustomers" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/relationships/damageCustomers" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/damageCustomers" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "flatRateCustomers" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/relationships/flatRateCustomers" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/flatRateCustomers" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claimPayees" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/relationships/claimPayees" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/claimPayees" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimPayeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimPayeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "billableCustomers" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/relationships/billableCustomers" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/billableCustomers" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetailsVersions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/relationships/investigationDetailsVersions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}/investigationDetailsVersions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CmsCustomersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CmsCustomersLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsCustomersAccount_level_customerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsCustomersLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsCustomersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsCustomersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsCustomersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsCustomersResourceLinks", "exampleSetFlag" : false } ] }, "CmsCustomersAccount_level_customer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsCustomersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsCustomers" ] }, "id" : { "$ref" : "#/components/schemas/CmsCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsCustomersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CmsCustomersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsCustomers" ] }, "id" : { "$ref" : "#/components/schemas/CmsCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_level_customer" : { "$ref" : "#/components/schemas/CmsCustomersAccount_level_customerResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CmsCustomersCreated_onResourceAttribute", "exampleSetFlag" : false }, "account_level_customer_id" : { "$ref" : "#/components/schemas/CmsCustomersAccount_level_customer_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CmsCustomersActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CmsCustomersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/CmsCustomersEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/CmsCustomersEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsCustomersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsCustomersClaimPayeesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimPayeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsCustomersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsCustomers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CmsCustomersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsCustomersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsCustomersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "active" : { "$ref" : "#/components/schemas/CmsCustomersActiveResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsDistricts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsDistrictsPostResourceReference", "exampleSetFlag" : false } ] }, "CmsDistrictsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CmsDistrictsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CmsDistrictsDistrict_codeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsDistrictsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsDistrictsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsDistrictsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsDistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsWorkday_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsDistrictsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsDistrictsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsDistrictsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsDistrictsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsDistricts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsDistricts" ] }, "id" : { "$ref" : "#/components/schemas/CmsDistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsDistrict_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsDistrictsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/CmsDistrictsDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsDistrictsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "district_abbr" : { "$ref" : "#/components/schemas/CmsDistrictsDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CmsDistrictsCreated_onResourceAttribute", "exampleSetFlag" : false }, "district_code" : { "$ref" : "#/components/schemas/CmsDistrictsDistrict_codeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CmsDistrictsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "workday_id" : { "$ref" : "#/components/schemas/CmsDistrictsWorkday_idResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/CmsDistrictsStateResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/CmsDistrictsRegionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsDistrictsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsDistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsDistrictsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsDistrictsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsDistrictsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsDistricts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsDistricts" ] }, "id" : { "$ref" : "#/components/schemas/CmsDistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsDistrictsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsDistrictsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsDistrictsResourceLinks", "exampleSetFlag" : false } ] }, "CmsDistrictsRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsDistrictsDistrict_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsDistrictsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsDistrictsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsDistrictsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsDistrictsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CmsErrorLogsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsErrorLogsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsErrorLogsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsErrorLogsResourceLinks", "exampleSetFlag" : false } ] }, "CmsErrorLogsError_stateResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsErrorLogsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "severity" : { "$ref" : "#/components/schemas/CmsErrorLogsSeverityResourceAttribute", "exampleSetFlag" : false }, "error_state" : { "$ref" : "#/components/schemas/CmsErrorLogsError_stateResourceAttribute", "exampleSetFlag" : false }, "module" : { "$ref" : "#/components/schemas/CmsErrorLogsModuleResourceAttribute", "exampleSetFlag" : false }, "line_no" : { "$ref" : "#/components/schemas/CmsErrorLogsLine_noResourceAttribute", "exampleSetFlag" : false }, "creation_date" : { "$ref" : "#/components/schemas/CmsErrorLogsCreation_dateResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/CmsErrorLogsMessageResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "severity" : { "$ref" : "#/components/schemas/CmsErrorLogsSeverityResourceAttribute", "exampleSetFlag" : false }, "error_state" : { "$ref" : "#/components/schemas/CmsErrorLogsError_stateResourceAttribute", "exampleSetFlag" : false }, "module" : { "$ref" : "#/components/schemas/CmsErrorLogsModuleResourceAttribute", "exampleSetFlag" : false }, "line_no" : { "$ref" : "#/components/schemas/CmsErrorLogsLine_noResourceAttribute", "exampleSetFlag" : false }, "creation_date" : { "$ref" : "#/components/schemas/CmsErrorLogsCreation_dateResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/CmsErrorLogsMessageResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsErrorLogsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsErrorLogsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsErrorLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsErrorLogs" ] }, "id" : { "$ref" : "#/components/schemas/CmsErrorLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsErrorLogsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "severity" : { "$ref" : "#/components/schemas/CmsErrorLogsSeverityResourceAttribute", "exampleSetFlag" : false }, "error_state" : { "$ref" : "#/components/schemas/CmsErrorLogsError_stateResourceAttribute", "exampleSetFlag" : false }, "module" : { "$ref" : "#/components/schemas/CmsErrorLogsModuleResourceAttribute", "exampleSetFlag" : false }, "line_no" : { "$ref" : "#/components/schemas/CmsErrorLogsLine_noResourceAttribute", "exampleSetFlag" : false }, "creation_date" : { "$ref" : "#/components/schemas/CmsErrorLogsCreation_dateResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/CmsErrorLogsMessageResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CmsErrorLogsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CmsErrorLogsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/errorLogs/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsErrorLogsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsErrorLogsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsModuleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsErrorLogsLine_noResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsErrorLogsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsErrorLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsErrorLogs" ] }, "id" : { "$ref" : "#/components/schemas/CmsErrorLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsErrorLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsMessageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsErrorLogsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsErrorLogsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsErrorLogsResourcePostAttributes", "exampleSetFlag" : false } ] }, "CmsErrorLogsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsErrorLogsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsErrorLogsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsErrorLogsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CmsErrorLogsSeverityResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsErrorLogsCreation_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CmsInvestigationDetailsSearch_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CmsInvestigationDetailsCompletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "CmsInvestigationDetailsCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CmsInvestigationDetailsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "investigationReport" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsAtt3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsVideo_urlResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsInvestigationDetailLinesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsInvestigationDetailsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsInvestigationDetailsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourcePostRelationships", "exampleSetFlag" : false } ] }, "CmsInvestigationDetailsSupervisor_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsInvestigationDetailsAtt4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "CmsInvestigationDetailsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsAtt5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsFacility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "investigationReport" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/relationships/investigationReport" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/investigationReport" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetailLines" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/relationships/investigationDetailLines" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/investigationDetailLines" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "utilitiesProfilesView" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/relationships/utilitiesProfilesView" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/utilitiesProfilesView" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UtilitiesProfilesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/relationships/customer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/customer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "estimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/relationships/estimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}/estimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsInvestigationReportResourceAttribute" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CmsInvestigationDetailsAtt2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CmsInvestigationDetailsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsInvestigationDetails)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsInvestigationDetails" ] }, "id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CmsInvestigationDetailsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsInvestigationDetails)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsInvestigationDetails" ] }, "id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsUtility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "investigationReport" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "inv_report_attachment_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsInv_report_attachment_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "supervisor_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsSupervisor_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "video_url" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsVideo_urlResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsLocator_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsFacility_idResourceAttribute", "exampleSetFlag" : false }, "att5" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt5ResourceAttribute", "exampleSetFlag" : false }, "att2" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt2ResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCompleted_byResourceAttribute", "exampleSetFlag" : false }, "att1" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt1ResourceAttribute", "exampleSetFlag" : false }, "att4" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt4ResourceAttribute", "exampleSetFlag" : false }, "att3" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt3ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsActiveResourceAttribute", "exampleSetFlag" : false }, "investigation_root_cause_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsInvestigation_root_cause_idResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCompletedResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCreated_byResourceAttribute", "exampleSetFlag" : false }, "supgroup" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsSupgroupResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "event_summary" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsEvent_summaryResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsSearch_textResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsInvestigation_root_cause_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CmsInvestigationDetailsEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsInvestigationDetailsUtilitiesProfilesViewResourceAttribute" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CmsInvestigationDetailsFacility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/cmsInvestigationDetails/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsAtt1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsInv_report_attachment_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsInvestigationDetailsInvestigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsCompleted_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "inv_report_attachment_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsInv_report_attachment_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "supervisor_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsSupervisor_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "video_url" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsVideo_urlResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsLocator_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsFacility_idResourceAttribute", "exampleSetFlag" : false }, "att5" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt5ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "att2" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt2ResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCompleted_byResourceAttribute", "exampleSetFlag" : false }, "att1" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt1ResourceAttribute", "exampleSetFlag" : false }, "att4" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt4ResourceAttribute", "exampleSetFlag" : false }, "att3" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt3ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsActiveResourceAttribute", "exampleSetFlag" : false }, "investigation_root_cause_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsInvestigation_root_cause_idResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCompletedResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCreated_byResourceAttribute", "exampleSetFlag" : false }, "supgroup" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsSupgroupResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "event_summary" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsEvent_summaryResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsSearch_textResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceLinks", "exampleSetFlag" : false } ] }, "CmsInvestigationDetailsLocator_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsInvestigationDetailsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "inv_report_attachment_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsInv_report_attachment_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "supervisor_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsSupervisor_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "video_url" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsVideo_urlResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsLocator_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsFacility_idResourceAttribute", "exampleSetFlag" : false }, "att5" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt5ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "att2" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt2ResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCompleted_byResourceAttribute", "exampleSetFlag" : false }, "att1" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt1ResourceAttribute", "exampleSetFlag" : false }, "att4" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt4ResourceAttribute", "exampleSetFlag" : false }, "att3" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsAtt3ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsActiveResourceAttribute", "exampleSetFlag" : false }, "investigation_root_cause_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsInvestigation_root_cause_idResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCompletedResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCreated_byResourceAttribute", "exampleSetFlag" : false }, "supgroup" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsSupgroupResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "event_summary" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsEvent_summaryResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCreated_onResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsSearch_textResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsInvestigationDetailsSupgroupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsEvent_summaryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsInvestigationDetailsCustomerResourceAttribute" : { "$ref" : "#/components/schemas/CustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CmsRequestsRequest_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsRequestsCompleted_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsLegalRisksResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsRequestsStart_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CmsRequestsParam5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsEnd_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CmsRequestsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "param7" : { "$ref" : "#/components/schemas/CmsRequestsParam7ResourceAttribute", "exampleSetFlag" : false }, "param8" : { "$ref" : "#/components/schemas/CmsRequestsParam8ResourceAttribute", "exampleSetFlag" : false }, "param5" : { "$ref" : "#/components/schemas/CmsRequestsParam5ResourceAttribute", "exampleSetFlag" : false }, "param6" : { "$ref" : "#/components/schemas/CmsRequestsParam6ResourceAttribute", "exampleSetFlag" : false }, "request_type" : { "$ref" : "#/components/schemas/CmsRequestsRequest_typeResourceAttribute", "exampleSetFlag" : false }, "param9" : { "$ref" : "#/components/schemas/CmsRequestsParam9ResourceAttribute", "exampleSetFlag" : false }, "end_time" : { "$ref" : "#/components/schemas/CmsRequestsEnd_timeResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/CmsRequestsSession_idResourceAttribute", "exampleSetFlag" : false }, "param3" : { "$ref" : "#/components/schemas/CmsRequestsParam3ResourceAttribute", "exampleSetFlag" : false }, "userid" : { "$ref" : "#/components/schemas/CmsRequestsUseridResourceAttribute", "exampleSetFlag" : false }, "param4" : { "$ref" : "#/components/schemas/CmsRequestsParam4ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsRequestsCreated_byResourceAttribute", "exampleSetFlag" : false }, "param1" : { "$ref" : "#/components/schemas/CmsRequestsParam1ResourceAttribute", "exampleSetFlag" : false }, "param2" : { "$ref" : "#/components/schemas/CmsRequestsParam2ResourceAttribute", "exampleSetFlag" : false }, "request_name" : { "$ref" : "#/components/schemas/CmsRequestsRequest_nameResourceAttribute", "exampleSetFlag" : false }, "start_time" : { "$ref" : "#/components/schemas/CmsRequestsStart_timeResourceAttribute", "exampleSetFlag" : false }, "completed_status" : { "$ref" : "#/components/schemas/CmsRequestsCompleted_statusResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsRequestsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "param10" : { "$ref" : "#/components/schemas/CmsRequestsParam10ResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/CmsRequestsEmp_idResourceAttribute", "exampleSetFlag" : false }, "username" : { "$ref" : "#/components/schemas/CmsRequestsUsernameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsParam9ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsRequestsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "param7" : { "$ref" : "#/components/schemas/CmsRequestsParam7ResourceAttribute", "exampleSetFlag" : false }, "param8" : { "$ref" : "#/components/schemas/CmsRequestsParam8ResourceAttribute", "exampleSetFlag" : false }, "param5" : { "$ref" : "#/components/schemas/CmsRequestsParam5ResourceAttribute", "exampleSetFlag" : false }, "param6" : { "$ref" : "#/components/schemas/CmsRequestsParam6ResourceAttribute", "exampleSetFlag" : false }, "request_type" : { "$ref" : "#/components/schemas/CmsRequestsRequest_typeResourceAttribute", "exampleSetFlag" : false }, "param9" : { "$ref" : "#/components/schemas/CmsRequestsParam9ResourceAttribute", "exampleSetFlag" : false }, "end_time" : { "$ref" : "#/components/schemas/CmsRequestsEnd_timeResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/CmsRequestsSession_idResourceAttribute", "exampleSetFlag" : false }, "param3" : { "$ref" : "#/components/schemas/CmsRequestsParam3ResourceAttribute", "exampleSetFlag" : false }, "userid" : { "$ref" : "#/components/schemas/CmsRequestsUseridResourceAttribute", "exampleSetFlag" : false }, "param4" : { "$ref" : "#/components/schemas/CmsRequestsParam4ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsRequestsCreated_byResourceAttribute", "exampleSetFlag" : false }, "param1" : { "$ref" : "#/components/schemas/CmsRequestsParam1ResourceAttribute", "exampleSetFlag" : false }, "param2" : { "$ref" : "#/components/schemas/CmsRequestsParam2ResourceAttribute", "exampleSetFlag" : false }, "request_name" : { "$ref" : "#/components/schemas/CmsRequestsRequest_nameResourceAttribute", "exampleSetFlag" : false }, "start_time" : { "$ref" : "#/components/schemas/CmsRequestsStart_timeResourceAttribute", "exampleSetFlag" : false }, "completed_status" : { "$ref" : "#/components/schemas/CmsRequestsCompleted_statusResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsRequestsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CmsRequestsCreated_onResourceAttribute", "exampleSetFlag" : false }, "param10" : { "$ref" : "#/components/schemas/CmsRequestsParam10ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CmsRequestsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/CmsRequestsEmp_idResourceAttribute", "exampleSetFlag" : false }, "username" : { "$ref" : "#/components/schemas/CmsRequestsUsernameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsParam1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CmsRequestsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CmsRequestsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsPolicyDropOffEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsRequestsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsRequestsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsRequestsResourcePostAttributes", "exampleSetFlag" : false } ] }, "CmsRequestsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsRequests)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsRequests" ] }, "id" : { "$ref" : "#/components/schemas/CmsRequestsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsParam6ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsAccrualsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsRequestsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsRequestsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsParam7ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/requests/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsRequestsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsRequestsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsRequestsParam2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "policyDropOffEstimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/requests/{id}/relationships/policyDropOffEstimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/requests/{id}/policyDropOffEstimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "accruals" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/requests/{id}/relationships/accruals" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/requests/{id}/accruals" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalRisks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/requests/{id}/relationships/legalRisks" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/requests/{id}/legalRisks" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "accrualSummaries" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/requests/{id}/relationships/accrualSummaries" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/requests/{id}/accrualSummaries" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsAccrualSummariesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CmsRequestsUsernameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsSession_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsRequestsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsRequests)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsRequests" ] }, "id" : { "$ref" : "#/components/schemas/CmsRequestsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "param7" : { "$ref" : "#/components/schemas/CmsRequestsParam7ResourceAttribute", "exampleSetFlag" : false }, "param8" : { "$ref" : "#/components/schemas/CmsRequestsParam8ResourceAttribute", "exampleSetFlag" : false }, "param5" : { "$ref" : "#/components/schemas/CmsRequestsParam5ResourceAttribute", "exampleSetFlag" : false }, "param6" : { "$ref" : "#/components/schemas/CmsRequestsParam6ResourceAttribute", "exampleSetFlag" : false }, "request_type" : { "$ref" : "#/components/schemas/CmsRequestsRequest_typeResourceAttribute", "exampleSetFlag" : false }, "param9" : { "$ref" : "#/components/schemas/CmsRequestsParam9ResourceAttribute", "exampleSetFlag" : false }, "end_time" : { "$ref" : "#/components/schemas/CmsRequestsEnd_timeResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/CmsRequestsSession_idResourceAttribute", "exampleSetFlag" : false }, "param3" : { "$ref" : "#/components/schemas/CmsRequestsParam3ResourceAttribute", "exampleSetFlag" : false }, "userid" : { "$ref" : "#/components/schemas/CmsRequestsUseridResourceAttribute", "exampleSetFlag" : false }, "param4" : { "$ref" : "#/components/schemas/CmsRequestsParam4ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsRequestsCreated_byResourceAttribute", "exampleSetFlag" : false }, "param1" : { "$ref" : "#/components/schemas/CmsRequestsParam1ResourceAttribute", "exampleSetFlag" : false }, "param2" : { "$ref" : "#/components/schemas/CmsRequestsParam2ResourceAttribute", "exampleSetFlag" : false }, "request_name" : { "$ref" : "#/components/schemas/CmsRequestsRequest_nameResourceAttribute", "exampleSetFlag" : false }, "start_time" : { "$ref" : "#/components/schemas/CmsRequestsStart_timeResourceAttribute", "exampleSetFlag" : false }, "completed_status" : { "$ref" : "#/components/schemas/CmsRequestsCompleted_statusResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsRequestsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "param10" : { "$ref" : "#/components/schemas/CmsRequestsParam10ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CmsRequestsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/CmsRequestsEmp_idResourceAttribute", "exampleSetFlag" : false }, "username" : { "$ref" : "#/components/schemas/CmsRequestsUsernameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsRequestsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CmsRequestsParam3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsParam10ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsRequest_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsUseridResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsRequestsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsRequestsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsRequestsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsRequestsResourceLinks", "exampleSetFlag" : false } ] }, "CmsRequestsParam4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsRequestsParam8ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsRequestsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsRequestsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsUserDataAccessesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsUserDataAccessesResourcePostAttributes", "exampleSetFlag" : false } ] }, "CmsUserDataAccessesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsUserDataAccessesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsUserDataAccessesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesPeoplesoft_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsUserDataAccessesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsUserDataAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsUserDataAccesses" ] }, "id" : { "$ref" : "#/components/schemas/CmsUserDataAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsUserDataAccessesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceLinks", "exampleSetFlag" : false } ] }, "CmsUserDataAccessesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsUserDataAccessesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CmsUserDataAccessesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CmsUserDataAccessesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsUserDataAccessesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/CmsUserDataAccessesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "peoplesoft_id" : { "$ref" : "#/components/schemas/CmsUserDataAccessesPeoplesoft_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsUserDataAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CmsUserDataAccessesCreated_onResourceAttribute", "exampleSetFlag" : false }, "all_districts" : { "$ref" : "#/components/schemas/CmsUserDataAccessesAll_districtsResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CmsUserDataAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/CmsUserDataAccessesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsUserDataAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/CmsUserDataAccessesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CmsUserDataAccessesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "district" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/userDataAccesses/{id}/relationships/district" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/userDataAccesses/{id}/district" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CmsUserDataAccessesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CmsUserDataAccessesAll_districtsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "CmsUserDataAccessesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cmsUserDataAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cmsUserDataAccesses" ] }, "id" : { "$ref" : "#/components/schemas/CmsUserDataAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CmsUserDataAccessesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/CmsUserDataAccessesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "peoplesoft_id" : { "$ref" : "#/components/schemas/CmsUserDataAccessesPeoplesoft_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsUserDataAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "all_districts" : { "$ref" : "#/components/schemas/CmsUserDataAccessesAll_districtsResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CmsUserDataAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/CmsUserDataAccessesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsUserDataAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/CmsUserDataAccessesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CmsUserDataAccessesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CmsUserDataAccessesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/CmsUserDataAccessesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "peoplesoft_id" : { "$ref" : "#/components/schemas/CmsUserDataAccessesPeoplesoft_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CmsUserDataAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "all_districts" : { "$ref" : "#/components/schemas/CmsUserDataAccessesAll_districtsResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/CmsUserDataAccessesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CmsUserDataAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/CmsUserDataAccessesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CmsUserDataAccessesDistrictResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CmsUserDataAccessesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/userDataAccesses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CommentsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CommentsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsIdeaResourceAttribute" : { "$ref" : "#/components/schemas/IdeasResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CommentsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (comments)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "comments" ] }, "id" : { "$ref" : "#/components/schemas/CommentsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CommentsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CommentsResourcePostAttributes", "exampleSetFlag" : false } ] }, "CommentsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CommentsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (comments)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "comments" ] }, "id" : { "$ref" : "#/components/schemas/CommentsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsContentResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CommentsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/CommentsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "idea_id" : { "$ref" : "#/components/schemas/CommentsIdea_idResourceAttribute", "exampleSetFlag" : false }, "author_id" : { "$ref" : "#/components/schemas/CommentsAuthor_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CommentsCreated_byResourceAttribute", "exampleSetFlag" : false }, "content" : { "$ref" : "#/components/schemas/CommentsContentResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CommentsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CommentsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/comments/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CommentsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CommentsAuthor_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CommentsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CommentsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CommentsIdea_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CommentsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CommentsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CommentsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CommentsResourceLinks", "exampleSetFlag" : false } ] }, "CommentsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "idea" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/comments/{id}/relationships/idea" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/comments/{id}/idea" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/comments/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/comments/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CommentsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/CommentsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CommentsCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CommentsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "idea_id" : { "$ref" : "#/components/schemas/CommentsIdea_idResourceAttribute", "exampleSetFlag" : false }, "author_id" : { "$ref" : "#/components/schemas/CommentsAuthor_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CommentsCreated_byResourceAttribute", "exampleSetFlag" : false }, "content" : { "$ref" : "#/components/schemas/CommentsContentResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CommentsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/CommentsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CommentsCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CommentsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "idea_id" : { "$ref" : "#/components/schemas/CommentsIdea_idResourceAttribute", "exampleSetFlag" : false }, "author_id" : { "$ref" : "#/components/schemas/CommentsAuthor_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CommentsCreated_byResourceAttribute", "exampleSetFlag" : false }, "content" : { "$ref" : "#/components/schemas/CommentsContentResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CommentsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CommentsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CommentsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "contract_effective_date" : { "$ref" : "#/components/schemas/ContractsContract_effective_dateResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/ContractsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "customer_contract_number" : { "$ref" : "#/components/schemas/ContractsCustomer_contract_numberResourceAttribute", "exampleSetFlag" : false }, "usic_contract_number" : { "$ref" : "#/components/schemas/ContractsUsic_contract_numberResourceAttribute", "exampleSetFlag" : false }, "primary_utility_type" : { "$ref" : "#/components/schemas/ContractsPrimary_utility_typeResourceAttribute", "exampleSetFlag" : false }, "utility_type" : { "$ref" : "#/components/schemas/ContractsUtility_typeResourceAttribute", "exampleSetFlag" : false }, "contract_expiration_date" : { "$ref" : "#/components/schemas/ContractsContract_expiration_dateResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/ContractsContract_nameResourceAttribute", "exampleSetFlag" : false }, "contract_stage" : { "$ref" : "#/components/schemas/ContractsContract_stageResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/ContractsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "usic_contract_type" : { "$ref" : "#/components/schemas/ContractsUsic_contract_typeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ContractsCreated_byResourceAttribute", "exampleSetFlag" : false }, "damage_liability" : { "$ref" : "#/components/schemas/ContractsDamage_liabilityResourceAttribute", "exampleSetFlag" : false }, "contract_type" : { "$ref" : "#/components/schemas/ContractsContract_typeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ContractsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "quote" : { "$ref" : "#/components/schemas/ContractsQuoteResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ContractsCreated_onResourceAttribute", "exampleSetFlag" : false }, "account_name" : { "$ref" : "#/components/schemas/ContractsAccount_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ContractsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "master_contract_number" : { "$ref" : "#/components/schemas/ContractsMaster_contract_numberResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/ContractsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/ContractsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customer" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ContractsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ContractsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ContractsResourceLinks", "exampleSetFlag" : false } ] }, "ContractsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ContractsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ContractsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsContract_effective_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ContractsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/contracts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ContractsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ContractsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ContractsCustomerResourceAttribute" : { "$ref" : "#/components/schemas/CustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ContractsStatusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsUsic_contract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsUtility_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsContract_stageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "contract_effective_date" : { "$ref" : "#/components/schemas/ContractsContract_effective_dateResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/ContractsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "customer_contract_number" : { "$ref" : "#/components/schemas/ContractsCustomer_contract_numberResourceAttribute", "exampleSetFlag" : false }, "usic_contract_number" : { "$ref" : "#/components/schemas/ContractsUsic_contract_numberResourceAttribute", "exampleSetFlag" : false }, "primary_utility_type" : { "$ref" : "#/components/schemas/ContractsPrimary_utility_typeResourceAttribute", "exampleSetFlag" : false }, "utility_type" : { "$ref" : "#/components/schemas/ContractsUtility_typeResourceAttribute", "exampleSetFlag" : false }, "contract_expiration_date" : { "$ref" : "#/components/schemas/ContractsContract_expiration_dateResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/ContractsContract_nameResourceAttribute", "exampleSetFlag" : false }, "contract_stage" : { "$ref" : "#/components/schemas/ContractsContract_stageResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/ContractsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "usic_contract_type" : { "$ref" : "#/components/schemas/ContractsUsic_contract_typeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ContractsCreated_byResourceAttribute", "exampleSetFlag" : false }, "damage_liability" : { "$ref" : "#/components/schemas/ContractsDamage_liabilityResourceAttribute", "exampleSetFlag" : false }, "contract_type" : { "$ref" : "#/components/schemas/ContractsContract_typeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ContractsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "quote" : { "$ref" : "#/components/schemas/ContractsQuoteResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ContractsCreated_onResourceAttribute", "exampleSetFlag" : false }, "account_name" : { "$ref" : "#/components/schemas/ContractsAccount_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ContractsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "master_contract_number" : { "$ref" : "#/components/schemas/ContractsMaster_contract_numberResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/ContractsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/ContractsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsDamage_liabilityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsQuoteResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ContractsCustomer_contract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "contract_effective_date" : { "$ref" : "#/components/schemas/ContractsContract_effective_dateResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/ContractsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "customer_contract_number" : { "$ref" : "#/components/schemas/ContractsCustomer_contract_numberResourceAttribute", "exampleSetFlag" : false }, "usic_contract_number" : { "$ref" : "#/components/schemas/ContractsUsic_contract_numberResourceAttribute", "exampleSetFlag" : false }, "primary_utility_type" : { "$ref" : "#/components/schemas/ContractsPrimary_utility_typeResourceAttribute", "exampleSetFlag" : false }, "utility_type" : { "$ref" : "#/components/schemas/ContractsUtility_typeResourceAttribute", "exampleSetFlag" : false }, "contract_expiration_date" : { "$ref" : "#/components/schemas/ContractsContract_expiration_dateResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/ContractsContract_nameResourceAttribute", "exampleSetFlag" : false }, "contract_stage" : { "$ref" : "#/components/schemas/ContractsContract_stageResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/ContractsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "usic_contract_type" : { "$ref" : "#/components/schemas/ContractsUsic_contract_typeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ContractsCreated_byResourceAttribute", "exampleSetFlag" : false }, "damage_liability" : { "$ref" : "#/components/schemas/ContractsDamage_liabilityResourceAttribute", "exampleSetFlag" : false }, "contract_type" : { "$ref" : "#/components/schemas/ContractsContract_typeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ContractsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "quote" : { "$ref" : "#/components/schemas/ContractsQuoteResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ContractsCreated_onResourceAttribute", "exampleSetFlag" : false }, "account_name" : { "$ref" : "#/components/schemas/ContractsAccount_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ContractsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "master_contract_number" : { "$ref" : "#/components/schemas/ContractsMaster_contract_numberResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/ContractsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/ContractsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsContract_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customer" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsUsic_contract_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (contracts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "contracts" ] }, "id" : { "$ref" : "#/components/schemas/ContractsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ContractsContract_expiration_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ContractsMaster_contract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ContractsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ContractsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ContractsResourcePostRelationships", "exampleSetFlag" : false } ] }, "ContractsAccount_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ContractsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsPrimary_utility_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsContract_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ContractsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/contracts/{id}/relationships/customer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/contracts/{id}/customer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ContractsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ContractsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ContractsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (contracts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "contracts" ] }, "id" : { "$ref" : "#/components/schemas/ContractsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "country_code" : { "$ref" : "#/components/schemas/CountriesCountry_codeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CountriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "country_name" : { "$ref" : "#/components/schemas/CountriesCountry_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CountriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CountriesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CountriesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CountriesResourceLinks", "exampleSetFlag" : false } ] }, "CountriesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "locations" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/countries/{id}/relationships/locations" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/countries/{id}/locations" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "states" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/countries/{id}/relationships/states" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/countries/{id}/states" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (countries)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "countries" ] }, "id" : { "$ref" : "#/components/schemas/CountriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesCountry_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CountriesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "locations" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "states" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CountriesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CountriesStatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CountriesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CountriesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "country_code" : { "$ref" : "#/components/schemas/CountriesCountry_codeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CountriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CountriesCreated_onResourceAttribute", "exampleSetFlag" : false }, "country_name" : { "$ref" : "#/components/schemas/CountriesCountry_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CountriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CountriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CountriesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CountriesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CountriesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CountriesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/countries/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CountriesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CountriesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CountriesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CountriesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CountriesResourcePostRelationships", "exampleSetFlag" : false } ] }, "CountriesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesCountry_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CountriesLocationsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CountriesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "country_code" : { "$ref" : "#/components/schemas/CountriesCountry_codeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CountriesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CountriesCreated_onResourceAttribute", "exampleSetFlag" : false }, "country_name" : { "$ref" : "#/components/schemas/CountriesCountry_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CountriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CountriesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CountriesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "locations" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "states" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CountriesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CountriesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (countries)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "countries" ] }, "id" : { "$ref" : "#/components/schemas/CountriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CountriesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CountriesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cpDistricts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cpDistricts" ] }, "id" : { "$ref" : "#/components/schemas/CpDistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsUsicContactsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CpDistrictsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CpDistrictsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/cpDistricts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsCp_created_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpDistrictsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CpDistrictsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpDistrictsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpDistrictsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsCp_district_codeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CpDistrictsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CpDistrictsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CpDistrictsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CpDistrictsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_district_code" : { "$ref" : "#/components/schemas/CpDistrictsCp_district_codeResourceAttribute", "exampleSetFlag" : false }, "cp_last_updated_by" : { "$ref" : "#/components/schemas/CpDistrictsCp_last_updated_byResourceAttribute", "exampleSetFlag" : false }, "cp_region" : { "$ref" : "#/components/schemas/CpDistrictsCp_regionResourceAttribute", "exampleSetFlag" : false }, "cp_created_by" : { "$ref" : "#/components/schemas/CpDistrictsCp_created_byResourceAttribute", "exampleSetFlag" : false }, "cp_workday_id" : { "$ref" : "#/components/schemas/CpDistrictsCp_workday_idResourceAttribute", "exampleSetFlag" : false }, "cp_district_name" : { "$ref" : "#/components/schemas/CpDistrictsCp_district_nameResourceAttribute", "exampleSetFlag" : false }, "cp_last_updated_on" : { "$ref" : "#/components/schemas/CpDistrictsCp_last_updated_onResourceAttribute", "exampleSetFlag" : false }, "cp_state" : { "$ref" : "#/components/schemas/CpDistrictsCp_stateResourceAttribute", "exampleSetFlag" : false }, "cp_district_abbr" : { "$ref" : "#/components/schemas/CpDistrictsCp_district_abbrResourceAttribute", "exampleSetFlag" : false }, "cp_created_on" : { "$ref" : "#/components/schemas/CpDistrictsCp_created_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "usicContacts" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/cpDistricts/{id}/relationships/usicContacts" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/cpDistricts/{id}/usicContacts" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CpDistrictsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpDistrictsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpDistrictsResourcePostRelationships", "exampleSetFlag" : false } ] }, "CpDistrictsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "usicContacts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "usicContacts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cpDistricts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cpDistricts" ] }, "id" : { "$ref" : "#/components/schemas/CpDistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsCp_workday_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CpDistrictsCp_district_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpDistrictsCp_created_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CpDistrictsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CpDistrictsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CpDistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsCp_last_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpDistrictsCp_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpDistrictsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CpDistrictsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpDistrictsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpDistrictsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpDistrictsResourceLinks", "exampleSetFlag" : false } ] }, "CpDistrictsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_district_code" : { "$ref" : "#/components/schemas/CpDistrictsCp_district_codeResourceAttribute", "exampleSetFlag" : false }, "cp_last_updated_by" : { "$ref" : "#/components/schemas/CpDistrictsCp_last_updated_byResourceAttribute", "exampleSetFlag" : false }, "cp_region" : { "$ref" : "#/components/schemas/CpDistrictsCp_regionResourceAttribute", "exampleSetFlag" : false }, "cp_created_by" : { "$ref" : "#/components/schemas/CpDistrictsCp_created_byResourceAttribute", "exampleSetFlag" : false }, "cp_workday_id" : { "$ref" : "#/components/schemas/CpDistrictsCp_workday_idResourceAttribute", "exampleSetFlag" : false }, "cp_district_name" : { "$ref" : "#/components/schemas/CpDistrictsCp_district_nameResourceAttribute", "exampleSetFlag" : false }, "cp_state" : { "$ref" : "#/components/schemas/CpDistrictsCp_stateResourceAttribute", "exampleSetFlag" : false }, "cp_district_abbr" : { "$ref" : "#/components/schemas/CpDistrictsCp_district_abbrResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsCp_district_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpDistrictsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_district_code" : { "$ref" : "#/components/schemas/CpDistrictsCp_district_codeResourceAttribute", "exampleSetFlag" : false }, "cp_last_updated_by" : { "$ref" : "#/components/schemas/CpDistrictsCp_last_updated_byResourceAttribute", "exampleSetFlag" : false }, "cp_region" : { "$ref" : "#/components/schemas/CpDistrictsCp_regionResourceAttribute", "exampleSetFlag" : false }, "cp_created_by" : { "$ref" : "#/components/schemas/CpDistrictsCp_created_byResourceAttribute", "exampleSetFlag" : false }, "cp_workday_id" : { "$ref" : "#/components/schemas/CpDistrictsCp_workday_idResourceAttribute", "exampleSetFlag" : false }, "cp_district_name" : { "$ref" : "#/components/schemas/CpDistrictsCp_district_nameResourceAttribute", "exampleSetFlag" : false }, "cp_last_updated_on" : { "$ref" : "#/components/schemas/CpDistrictsCp_last_updated_onResourceAttribute", "exampleSetFlag" : false }, "cp_state" : { "$ref" : "#/components/schemas/CpDistrictsCp_stateResourceAttribute", "exampleSetFlag" : false }, "cp_district_abbr" : { "$ref" : "#/components/schemas/CpDistrictsCp_district_abbrResourceAttribute", "exampleSetFlag" : false }, "cp_created_on" : { "$ref" : "#/components/schemas/CpDistrictsCp_created_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CpDistrictsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CpDistrictsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CpDistrictsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpDistrictsCp_regionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpDistrictsCp_last_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CpstorageVolumesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CpstorageVolumesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpstorageVolumesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cpstorageVolumes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cpstorageVolumes" ] }, "id" : { "$ref" : "#/components/schemas/CpstorageVolumesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CpstorageVolumesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "path" : { "$ref" : "#/components/schemas/CpstorageVolumesPathResourceAttribute", "exampleSetFlag" : false }, "protocol" : { "$ref" : "#/components/schemas/CpstorageVolumesProtocolResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CpstorageVolumesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CpstorageVolumesCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/CpstorageVolumesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CpstorageVolumesActiveResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/CpstorageVolumesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CpstorageVolumesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/CpstorageVolumesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CpstorageVolumesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "path" : { "$ref" : "#/components/schemas/CpstorageVolumesPathResourceAttribute", "exampleSetFlag" : false }, "protocol" : { "$ref" : "#/components/schemas/CpstorageVolumesProtocolResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CpstorageVolumesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/CpstorageVolumesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CpstorageVolumesActiveResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/CpstorageVolumesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/CpstorageVolumesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CpstorageVolumesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "path" : { "$ref" : "#/components/schemas/CpstorageVolumesPathResourceAttribute", "exampleSetFlag" : false }, "protocol" : { "$ref" : "#/components/schemas/CpstorageVolumesProtocolResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CpstorageVolumesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/CpstorageVolumesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CpstorageVolumesActiveResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/CpstorageVolumesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CpstorageVolumesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/CpstorageVolumesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CpstorageVolumesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CpstorageVolumesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CpstorageVolumesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CpstorageVolumesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CpstorageVolumesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpstorageVolumesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpstorageVolumesResourceLinks", "exampleSetFlag" : false } ] }, "CpstorageVolumesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CpstorageVolumesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CpstorageVolumesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpstorageVolumesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CpstorageVolumesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpstorageVolumesResourcePostAttributes", "exampleSetFlag" : false } ] }, "CpstorageVolumesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpstorageVolumesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/cpstorageVolumes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CpstorageVolumesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CpstorageVolumesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CpstorageVolumesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CpstorageVolumesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpstorageVolumesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CpstorageVolumesProtocolResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpstorageVolumesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CpstorageVolumesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (cpstorageVolumes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "cpstorageVolumes" ] }, "id" : { "$ref" : "#/components/schemas/CpstorageVolumesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CpstorageVolumesPathResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpstorageVolumesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CpstorageVolumesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "CustomerAccountActivitiesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CustomerAccountActivitiesShow_managed_servicesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountActivitiesLast_logged_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CustomerAccountActivitiesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountActivitiesShow_ticketsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountActivitiesNum_usersResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CustomerAccountActivitiesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerAccountActivities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerAccountActivities" ] }, "id" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountActivitiesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerAccountActivitiesPostResourceReference", "exampleSetFlag" : false } ] }, "CustomerAccountActivitiesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerAccountActivities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerAccountActivities" ] }, "id" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountActivitiesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CustomerAccountActivitiesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountActivitiesShow_damagesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountActivitiesAccount_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountActivitiesCustomerAccountResourceAttribute" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CustomerAccountActivitiesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesAccount_numberResourceAttribute", "exampleSetFlag" : false }, "show_damages" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesShow_damagesResourceAttribute", "exampleSetFlag" : false }, "num_users" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesNum_usersResourceAttribute", "exampleSetFlag" : false }, "account_name" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesAccount_nameResourceAttribute", "exampleSetFlag" : false }, "show_tickets" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesShow_ticketsResourceAttribute", "exampleSetFlag" : false }, "last_logged_on" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesLast_logged_onResourceAttribute", "exampleSetFlag" : false }, "days" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesDaysResourceAttribute", "exampleSetFlag" : false }, "show_managed_services" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesShow_managed_servicesResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountActivitiesAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountActivitiesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccountActivities/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountActivitiesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerAccount" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccountActivities/{id}/relationships/customerAccount" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccountActivities/{id}/customerAccount" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountActivitiesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CustomerAccountActivitiesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountActivitiesDaysResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CustomerAccountActivitiesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceLinks", "exampleSetFlag" : false } ] }, "CustomerAccountActivitiesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountActivitiesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerAccount" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccountNotes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CustomerAccountNotesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerAccountNotesAccount_numberResourceAttribute", "exampleSetFlag" : false }, "note" : { "$ref" : "#/components/schemas/CustomerAccountNotesNoteResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerAccountNotesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CustomerAccountNotesCreated_onResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CustomerAccountNotesActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerAccountNotesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerAccountNotesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountNotesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountNotesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountNotesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountNotesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesCustomerAccountResourceAttribute" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CustomerAccountNotesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CustomerAccountNotesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerAccountNotes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerAccountNotes" ] }, "id" : { "$ref" : "#/components/schemas/CustomerAccountNotesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesNoteResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountNotesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CustomerAccountNotesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountNotesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CustomerAccountNotesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerAccount" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccountNotes/{id}/relationships/customerAccount" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccountNotes/{id}/customerAccount" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerAccountNotesAccount_numberResourceAttribute", "exampleSetFlag" : false }, "note" : { "$ref" : "#/components/schemas/CustomerAccountNotesNoteResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerAccountNotesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CustomerAccountNotesActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerAccountNotesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerAccountNotesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerAccountNotesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerAccountNotes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerAccountNotes" ] }, "id" : { "$ref" : "#/components/schemas/CustomerAccountNotesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerAccount" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountNotesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountNotesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountNotesResourceLinks", "exampleSetFlag" : false } ] }, "CustomerAccountNotesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CustomerAccountNotesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerAccountNotesAccount_numberResourceAttribute", "exampleSetFlag" : false }, "note" : { "$ref" : "#/components/schemas/CustomerAccountNotesNoteResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerAccountNotesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/CustomerAccountNotesActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerAccountNotesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountNotesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerAccountNotesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountNotesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountNotesResourcePostRelationships", "exampleSetFlag" : false } ] }, "CustomerAccountNotesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "CustomerAccountsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccounts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerAccountsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountsResourcePostRelationships", "exampleSetFlag" : false } ] }, "CustomerAccountsUserAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CustomerAccountsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerAccountsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "alt_name" : { "$ref" : "#/components/schemas/CustomerAccountsAlt_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerAccountsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "account_name" : { "$ref" : "#/components/schemas/CustomerAccountsAccount_nameResourceAttribute", "exampleSetFlag" : false }, "parent_account_number" : { "$ref" : "#/components/schemas/CustomerAccountsParent_account_numberResourceAttribute", "exampleSetFlag" : false }, "item_status" : { "$ref" : "#/components/schemas/CustomerAccountsItem_statusResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerAccountsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerAccountsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CustomerAccountsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerAccountsResourceLinks", "exampleSetFlag" : false } ] }, "CustomerAccountsUserAccountContractAccessResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CustomerAccountsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerAccountsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "userAccountContractAccess" : { "$ref" : "#/components/schemas/CustomerAccountsUserAccountContractAccessResourceAttribute", "exampleSetFlag" : false }, "alt_name" : { "$ref" : "#/components/schemas/CustomerAccountsAlt_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerAccountsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CustomerAccountsCreated_onResourceAttribute", "exampleSetFlag" : false }, "account_name" : { "$ref" : "#/components/schemas/CustomerAccountsAccount_nameResourceAttribute", "exampleSetFlag" : false }, "parent_account_number" : { "$ref" : "#/components/schemas/CustomerAccountsParent_account_numberResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerAccountsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "item_status" : { "$ref" : "#/components/schemas/CustomerAccountsItem_statusResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerAccountsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsItem_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountsCustomerContractSettingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CustomerAccountsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerAccounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerAccounts" ] }, "id" : { "$ref" : "#/components/schemas/CustomerAccountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerAccountNotes" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerContracts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerAccountsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CustomerAccountsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerAccountNotes" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerContracts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsAccount_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CustomerAccountsCustomerContractsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CustomerAccountsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerAccountNotes" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccounts/{id}/relationships/customerAccountNotes" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccounts/{id}/customerAccountNotes" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerContractSettings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccounts/{id}/relationships/customerContractSettings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccounts/{id}/customerContractSettings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccounts/{id}/relationships/userAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccounts/{id}/userAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerContracts" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccounts/{id}/relationships/customerContracts" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerAccounts/{id}/customerContracts" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsParent_account_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerAccounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerAccounts" ] }, "id" : { "$ref" : "#/components/schemas/CustomerAccountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerAccountsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "alt_name" : { "$ref" : "#/components/schemas/CustomerAccountsAlt_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerAccountsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "account_name" : { "$ref" : "#/components/schemas/CustomerAccountsAccount_nameResourceAttribute", "exampleSetFlag" : false }, "parent_account_number" : { "$ref" : "#/components/schemas/CustomerAccountsParent_account_numberResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerAccountsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "item_status" : { "$ref" : "#/components/schemas/CustomerAccountsItem_statusResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerAccountsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsCustomerAccountNotesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CustomerAccountsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CustomerAccountsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerAccountsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CustomerAccountsAlt_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerAccountsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractSettingsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CustomerContractSettingsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerContractSettings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerContractSettings" ] }, "id" : { "$ref" : "#/components/schemas/CustomerContractSettingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsFilter_attachmentsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "CustomerContractSettingsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerContractSettingsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "filter_attachments" : { "$ref" : "#/components/schemas/CustomerContractSettingsFilter_attachmentsResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerContractSettingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/CustomerContractSettingsContract_numberResourceAttribute", "exampleSetFlag" : false }, "theme" : { "$ref" : "#/components/schemas/CustomerContractSettingsThemeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerContractSettingsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerContractSettingsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractSettingsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContractSettings/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerContractSettingsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "filter_attachments" : { "$ref" : "#/components/schemas/CustomerContractSettingsFilter_attachmentsResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerContractSettingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/CustomerContractSettingsContract_numberResourceAttribute", "exampleSetFlag" : false }, "theme" : { "$ref" : "#/components/schemas/CustomerContractSettingsThemeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerContractSettingsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerContractSettingsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CustomerContractSettingsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerContractSettingsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerContractSettingsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "filter_attachments" : { "$ref" : "#/components/schemas/CustomerContractSettingsFilter_attachmentsResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerContractSettingsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/CustomerContractSettingsContract_numberResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CustomerContractSettingsCreated_onResourceAttribute", "exampleSetFlag" : false }, "theme" : { "$ref" : "#/components/schemas/CustomerContractSettingsThemeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerContractSettingsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerContractSettingsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsCustomerAccountResourceAttribute" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CustomerContractSettingsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractSettingsContract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractSettingsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CustomerContractSettingsCustomerContractResourceAttribute" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CustomerContractSettingsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractSettingsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractSettingsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractSettingsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractSettingsResourceLinks", "exampleSetFlag" : false } ] }, "CustomerContractSettingsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractSettingsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CustomerContractSettingsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerContract" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContractSettings/{id}/relationships/customerContract" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContractSettings/{id}/customerContract" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerAccount" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContractSettings/{id}/relationships/customerAccount" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContractSettings/{id}/customerAccount" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerContractSettingsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractSettingsResourcePostAttributes", "exampleSetFlag" : false } ] }, "CustomerContractSettingsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerContractSettings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerContractSettings" ] }, "id" : { "$ref" : "#/components/schemas/CustomerContractSettingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractSettingsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractSettingsThemeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractSettingsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CustomerContractStatesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractStatesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CustomerContractStatesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customer" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerContractStatesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CustomerContractStatesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerContractStatesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerContractStatesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractStatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerContractStatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractStatesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractStatesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractStatesStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractStatesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerContractStates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerContractStates" ] }, "id" : { "$ref" : "#/components/schemas/CustomerContractStatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesCustomerResourceAttribute" : { "$ref" : "#/components/schemas/CustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "CustomerContractStatesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractStatesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CustomerContractStatesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractStatesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerContractStates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerContractStates" ] }, "id" : { "$ref" : "#/components/schemas/CustomerContractStatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerContractStatesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractStatesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractStatesResourcePostRelationships", "exampleSetFlag" : false } ] }, "CustomerContractStatesIdResourceAttribute" : { "type" : "object", "properties" : { "account_number" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "contract_number" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "state" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerContractStatesAccount_numberResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerContractStatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/CustomerContractStatesContract_numberResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CustomerContractStatesCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerContractStatesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/CustomerContractStatesStateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerContractStatesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/CustomerContractStatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerContractStatesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerContractStatesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/CustomerContractStatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerContractStatesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractStatesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContractStates/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerContractStatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractStatesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractStatesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractStatesResourceLinks", "exampleSetFlag" : false } ] }, "CustomerContractStatesContract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractStatesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customer" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractStatesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CustomerContractStatesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContractStates/{id}/relationships/customer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContractStates/{id}/customer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerContractsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerContractsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/CustomerContractsContract_numberResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/CustomerContractsContract_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerContractsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/CustomerContractsStateResourceAttribute", "exampleSetFlag" : false }, "item_status" : { "$ref" : "#/components/schemas/CustomerContractsItem_statusResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerContractsCreated_byResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/CustomerContractsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsCustomerContractSettingResourceAttribute" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "nullable" : false, "exampleSetFlag" : false }, "CustomerContractsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CustomerContractsStatusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractsContract_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerContractsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CustomerContractsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerContractsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsContract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerContractSetting" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerContractsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerContractsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/CustomerContractsContract_numberResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/CustomerContractsContract_nameResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/CustomerContractsStateResourceAttribute", "exampleSetFlag" : false }, "item_status" : { "$ref" : "#/components/schemas/CustomerContractsItem_statusResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerContractsCreated_byResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/CustomerContractsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CustomerContractsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CustomerContractsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractsResourceLinks", "exampleSetFlag" : false } ] }, "CustomerContractsUserAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CustomerContractsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/CustomerContractsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomerContractsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/CustomerContractsContract_numberResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CustomerContractsCreated_onResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/CustomerContractsContract_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomerContractsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/CustomerContractsStateResourceAttribute", "exampleSetFlag" : false }, "item_status" : { "$ref" : "#/components/schemas/CustomerContractsItem_statusResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomerContractsCreated_byResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/CustomerContractsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsItem_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContracts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerContracts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerContracts" ] }, "id" : { "$ref" : "#/components/schemas/CustomerContractsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "CustomerContractsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "userAccountContractAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContracts/{id}/relationships/userAccountContractAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContracts/{id}/userAccountContractAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerContractSetting" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContracts/{id}/relationships/customerContractSetting" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContracts/{id}/customerContractSetting" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContracts/{id}/relationships/userAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/customerContracts/{id}/userAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomerContractsUserAccountContractAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "CustomerContractsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerContractsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractsResourcePostRelationships", "exampleSetFlag" : false } ] }, "CustomerContractsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customerContracts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customerContracts" ] }, "id" : { "$ref" : "#/components/schemas/CustomerContractsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerContractSetting" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomerContractsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomerContractsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "contracts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customers" ] }, "id" : { "$ref" : "#/components/schemas/CustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomersEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CustomersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/CustomersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "CustomersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (customers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "customers" ] }, "id" : { "$ref" : "#/components/schemas/CustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_level_customer" : { "$ref" : "#/components/schemas/CustomersAccount_level_customerResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CustomersCreated_onResourceAttribute", "exampleSetFlag" : false }, "account_level_customer_id" : { "$ref" : "#/components/schemas/CustomersAccount_level_customer_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/CustomersEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/CustomersEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CustomersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CustomersCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CustomersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_level_customer" : { "$ref" : "#/components/schemas/CustomersAccount_level_customerResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CustomersCreated_onResourceAttribute", "exampleSetFlag" : false }, "account_level_customer_id" : { "$ref" : "#/components/schemas/CustomersAccount_level_customer_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/CustomersEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/CustomersEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "contracts" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/customers/{id}/relationships/contracts" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/customers/{id}/contracts" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomersResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomersResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "contracts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/CustomersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomersResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomersResourcePostRelationships", "exampleSetFlag" : false } ] }, "CustomersLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "CustomersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/customers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersAccount_level_customer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "CustomersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "CustomersCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_level_customer" : { "$ref" : "#/components/schemas/CustomersAccount_level_customerResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/CustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/CustomersCreated_onResourceAttribute", "exampleSetFlag" : false }, "account_level_customer_id" : { "$ref" : "#/components/schemas/CustomersAccount_level_customer_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/CustomersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/CustomersEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/CustomersEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/CustomersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "CustomersAccount_level_customerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "CustomersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/CustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/CustomersResourceLinks", "exampleSetFlag" : false } ] }, "CustomersContractsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DamageCustomersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageCustomersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DamageCustomersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/DamageCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/DamageCustomersCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DamageCustomersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/DamageCustomersCustomer_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DamageCustomersCreated_byResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/DamageCustomersDamage_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageCustomersDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamageCustomersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DamageCustomersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DamageCustomersCmsCustomerResourceAttribute" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamageCustomersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/DamageCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DamageCustomersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersIdResourceAttribute" : { "type" : "object", "properties" : { "damage_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "customer_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamageCustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageCustomersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageCustomersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageCustomersResourceLinks", "exampleSetFlag" : false } ] }, "DamageCustomersDamage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageCustomersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageCustomers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageCustomers/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageCustomers/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsCustomer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageCustomers/{id}/relationships/cmsCustomer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageCustomers/{id}/cmsCustomer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/DamageCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DamageCustomersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DamageCustomersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageCustomersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamageCustomersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageCustomersResourcePostAttributes", "exampleSetFlag" : false } ] }, "DamageCustomersCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DamageCustomersLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DamageCustomersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damageCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damageCustomers" ] }, "id" : { "$ref" : "#/components/schemas/DamageCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageCustomersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamageCustomersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageCustomersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamageCustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageCustomersResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damageCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damageCustomers" ] }, "id" : { "$ref" : "#/components/schemas/DamageCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageCustomersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamageCustomersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsDd_pictures_taken_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageDetailsDd_investigation_date_toResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_address_2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_damaging_excavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_cityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamageDetailsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageDetailsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageDetailsResourceLinks", "exampleSetFlag" : false } ] }, "DamageDetailsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageDetails/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsDd_caller_companyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_further_investigation_neededResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageDetailsDd_investigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageDetailsDd_type_of_ticketResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_orig_locate_requestResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_date_reportedResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamageDetailsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "dd_notified_by" : { "$ref" : "#/components/schemas/DamageDetailsDd_notified_byResourceAttribute", "exampleSetFlag" : false }, "dd_damaging_excavator" : { "$ref" : "#/components/schemas/DamageDetailsDd_damaging_excavatorResourceAttribute", "exampleSetFlag" : false }, "dd_notes" : { "$ref" : "#/components/schemas/DamageDetailsDd_notesResourceAttribute", "exampleSetFlag" : false }, "dd_date_reported" : { "$ref" : "#/components/schemas/DamageDetailsDd_date_reportedResourceAttribute", "exampleSetFlag" : false }, "dd_investigation_id" : { "$ref" : "#/components/schemas/DamageDetailsDd_investigation_idResourceAttribute", "exampleSetFlag" : false }, "dd_district" : { "$ref" : "#/components/schemas/DamageDetailsDd_districtResourceAttribute", "exampleSetFlag" : false }, "dd_further_investigation_needed" : { "$ref" : "#/components/schemas/DamageDetailsDd_further_investigation_neededResourceAttribute", "exampleSetFlag" : false }, "dd_notification_id" : { "$ref" : "#/components/schemas/DamageDetailsDd_notification_idResourceAttribute", "exampleSetFlag" : false }, "dd_investigation_date_from" : { "$ref" : "#/components/schemas/DamageDetailsDd_investigation_date_fromResourceAttribute", "exampleSetFlag" : false }, "dd_type_of_excavation" : { "$ref" : "#/components/schemas/DamageDetailsDd_type_of_excavationResourceAttribute", "exampleSetFlag" : false }, "dd_type_of_ticket" : { "$ref" : "#/components/schemas/DamageDetailsDd_type_of_ticketResourceAttribute", "exampleSetFlag" : false }, "dd_contact_info" : { "$ref" : "#/components/schemas/DamageDetailsDd_contact_infoResourceAttribute", "exampleSetFlag" : false }, "dd_investigation_date_to" : { "$ref" : "#/components/schemas/DamageDetailsDd_investigation_date_toResourceAttribute", "exampleSetFlag" : false }, "dd_damaged_customer" : { "$ref" : "#/components/schemas/DamageDetailsDd_damaged_customerResourceAttribute", "exampleSetFlag" : false }, "dd_state" : { "$ref" : "#/components/schemas/DamageDetailsDd_stateResourceAttribute", "exampleSetFlag" : false }, "dd_zip_code" : { "$ref" : "#/components/schemas/DamageDetailsDd_zip_codeResourceAttribute", "exampleSetFlag" : false }, "dd_damage_request" : { "$ref" : "#/components/schemas/DamageDetailsDd_damage_requestResourceAttribute", "exampleSetFlag" : false }, "dd_orig_request_id" : { "$ref" : "#/components/schemas/DamageDetailsDd_orig_request_idResourceAttribute", "exampleSetFlag" : false }, "dd_cdi_emp_id" : { "$ref" : "#/components/schemas/DamageDetailsDd_cdi_emp_idResourceAttribute", "exampleSetFlag" : false }, "dd_call_date" : { "$ref" : "#/components/schemas/DamageDetailsDd_call_dateResourceAttribute", "exampleSetFlag" : false }, "dd_caller_company" : { "$ref" : "#/components/schemas/DamageDetailsDd_caller_companyResourceAttribute", "exampleSetFlag" : false }, "dd_cdi_confirmation" : { "$ref" : "#/components/schemas/DamageDetailsDd_cdi_confirmationResourceAttribute", "exampleSetFlag" : false }, "dd_orig_locate_request" : { "$ref" : "#/components/schemas/DamageDetailsDd_orig_locate_requestResourceAttribute", "exampleSetFlag" : false }, "dd_start_date" : { "$ref" : "#/components/schemas/DamageDetailsDd_start_dateResourceAttribute", "exampleSetFlag" : false }, "dd_address_2" : { "$ref" : "#/components/schemas/DamageDetailsDd_address_2ResourceAttribute", "exampleSetFlag" : false }, "dd_city" : { "$ref" : "#/components/schemas/DamageDetailsDd_cityResourceAttribute", "exampleSetFlag" : false }, "dd_pictures_taken_by" : { "$ref" : "#/components/schemas/DamageDetailsDd_pictures_taken_byResourceAttribute", "exampleSetFlag" : false }, "dd_address_1" : { "$ref" : "#/components/schemas/DamageDetailsDd_address_1ResourceAttribute", "exampleSetFlag" : false }, "dd_damage_date" : { "$ref" : "#/components/schemas/DamageDetailsDd_damage_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamageDetailsPostResourceReference", "exampleSetFlag" : false } ] }, "DamageDetailsDd_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_districtResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamageDetailsDd_damaged_customerResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageDetailsDd_contact_infoResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageDetailsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageDetailsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsDd_call_dateResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageDetailsDd_notification_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_notesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamageDetailsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageDetailsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DamageDetailsDd_type_of_excavationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_cdi_confirmationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_investigation_date_fromResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damageDetails)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damageDetails" ] }, "id" : { "$ref" : "#/components/schemas/DamageDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamageDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DamageDetailsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DamageDetailsDd_damage_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamageDetailsDd_address_1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_notified_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsDd_zip_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsDd_damage_requestResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageDetailsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damageDetails)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damageDetails" ] }, "id" : { "$ref" : "#/components/schemas/DamageDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamageDetailsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageDetailsDd_cdi_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageDetailsDd_orig_request_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageListingsDl_account_numberResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageListingsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageListingsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DamageListingsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageListingsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "duplicateDamage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageListings/{id}/relationships/duplicateDamage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageListings/{id}/duplicateDamage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageListings/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageListings/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamageListingsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageListingsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageListingsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamageListingsResourceLinks", "exampleSetFlag" : false } ] }, "DamageListingsDl_add1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageListingsDl_damage_date_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamageListingsDl_customer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageListingsIdResourceAttribute" : { "type" : "object", "properties" : { "dl_notification_id" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "dl_customer_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageListingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsDl_duplicate_damage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageListingsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DamageListingsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DamageListingsDl_damage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamageListingsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamageListingsPostResourceReference", "exampleSetFlag" : false } ] }, "DamageListingsDuplicateDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamageListingsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "dl_city" : { "$ref" : "#/components/schemas/DamageListingsDl_cityResourceAttribute", "exampleSetFlag" : false }, "dl_damage_date_time" : { "$ref" : "#/components/schemas/DamageListingsDl_damage_date_timeResourceAttribute", "exampleSetFlag" : false }, "dl_duplicate_damage_id" : { "$ref" : "#/components/schemas/DamageListingsDl_duplicate_damage_idResourceAttribute", "exampleSetFlag" : false }, "dl_damage_id" : { "$ref" : "#/components/schemas/DamageListingsDl_damage_idResourceAttribute", "exampleSetFlag" : false }, "dl_customer_id" : { "$ref" : "#/components/schemas/DamageListingsDl_customer_idResourceAttribute", "exampleSetFlag" : false }, "dl_notification_id" : { "$ref" : "#/components/schemas/DamageListingsDl_notification_idResourceAttribute", "exampleSetFlag" : false }, "dl_add1" : { "$ref" : "#/components/schemas/DamageListingsDl_add1ResourceAttribute", "exampleSetFlag" : false }, "dl_customer_claim_number" : { "$ref" : "#/components/schemas/DamageListingsDl_customer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "dl_account_number" : { "$ref" : "#/components/schemas/DamageListingsDl_account_numberResourceAttribute", "exampleSetFlag" : false }, "dl_abbrev" : { "$ref" : "#/components/schemas/DamageListingsDl_abbrevResourceAttribute", "exampleSetFlag" : false }, "dl_excavator" : { "$ref" : "#/components/schemas/DamageListingsDl_excavatorResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsDl_abbrevResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageListingsDl_notification_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageListingsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damageListings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damageListings" ] }, "id" : { "$ref" : "#/components/schemas/DamageListingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damageListings/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsDl_cityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageListingsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamageListingsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamageListingsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamageListingsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damageListings)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damageListings" ] }, "id" : { "$ref" : "#/components/schemas/DamageListingsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamageListingsDl_customer_claim_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageListingsDl_excavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamageListingsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamageListingsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosAttachmentEntitiesResourceAttribute" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamagePhotosResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DamagePhotosPrivResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "DamagePhotosDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamagePhotosVolResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagePhotosResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damagePhotos/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damagePhotos/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damagePhotos/{id}/relationships/investigationDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damagePhotos/{id}/investigationDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsInvestigationDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damagePhotos/{id}/relationships/cmsInvestigationDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damagePhotos/{id}/cmsInvestigationDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentEntities" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damagePhotos/{id}/relationships/attachmentEntities" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damagePhotos/{id}/attachmentEntities" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosAttachment_entity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagePhotosFilesizeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "filetype" : { "$ref" : "#/components/schemas/DamagePhotosFiletypeResourceAttribute", "exampleSetFlag" : false }, "volume_id" : { "$ref" : "#/components/schemas/DamagePhotosVolume_idResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_id" : { "$ref" : "#/components/schemas/DamagePhotosAttachment_entity_idResourceAttribute", "exampleSetFlag" : false }, "fullUrl" : { "$ref" : "#/components/schemas/DamagePhotosFullUrlResourceAttribute", "exampleSetFlag" : false }, "entity_table" : { "$ref" : "#/components/schemas/DamagePhotosEntity_tableResourceAttribute", "exampleSetFlag" : false }, "pk1_int" : { "$ref" : "#/components/schemas/DamagePhotosPk1_intResourceAttribute", "exampleSetFlag" : false }, "entityID" : { "$ref" : "#/components/schemas/DamagePhotosEntityIDResourceAttribute", "exampleSetFlag" : false }, "filesize" : { "$ref" : "#/components/schemas/DamagePhotosFilesizeResourceAttribute", "exampleSetFlag" : false }, "path" : { "$ref" : "#/components/schemas/DamagePhotosPathResourceAttribute", "exampleSetFlag" : false }, "number" : { "$ref" : "#/components/schemas/DamagePhotosNumberResourceAttribute", "exampleSetFlag" : false }, "protocol" : { "$ref" : "#/components/schemas/DamagePhotosProtocolResourceAttribute", "exampleSetFlag" : false }, "vol" : { "$ref" : "#/components/schemas/DamagePhotosVolResourceAttribute", "exampleSetFlag" : false }, "filename" : { "$ref" : "#/components/schemas/DamagePhotosFilenameResourceAttribute", "exampleSetFlag" : false }, "fulltnUrl" : { "$ref" : "#/components/schemas/DamagePhotosFulltnUrlResourceAttribute", "exampleSetFlag" : false }, "host" : { "$ref" : "#/components/schemas/DamagePhotosHostResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_name" : { "$ref" : "#/components/schemas/DamagePhotosAttachment_entity_nameResourceAttribute", "exampleSetFlag" : false }, "priv" : { "$ref" : "#/components/schemas/DamagePhotosPrivResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosAttachment_entity_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosFullUrlResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosNumberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "damage" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetail" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsInvestigationDetail" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentEntities" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagePhotosPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damagePhotos)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damagePhotos" ] }, "id" : { "$ref" : "#/components/schemas/DamagePhotosIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagePhotosResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagePhotosResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "filetype" : { "$ref" : "#/components/schemas/DamagePhotosFiletypeResourceAttribute", "exampleSetFlag" : false }, "volume_id" : { "$ref" : "#/components/schemas/DamagePhotosVolume_idResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_id" : { "$ref" : "#/components/schemas/DamagePhotosAttachment_entity_idResourceAttribute", "exampleSetFlag" : false }, "fullUrl" : { "$ref" : "#/components/schemas/DamagePhotosFullUrlResourceAttribute", "exampleSetFlag" : false }, "entity_table" : { "$ref" : "#/components/schemas/DamagePhotosEntity_tableResourceAttribute", "exampleSetFlag" : false }, "pk1_int" : { "$ref" : "#/components/schemas/DamagePhotosPk1_intResourceAttribute", "exampleSetFlag" : false }, "entityID" : { "$ref" : "#/components/schemas/DamagePhotosEntityIDResourceAttribute", "exampleSetFlag" : false }, "filesize" : { "$ref" : "#/components/schemas/DamagePhotosFilesizeResourceAttribute", "exampleSetFlag" : false }, "path" : { "$ref" : "#/components/schemas/DamagePhotosPathResourceAttribute", "exampleSetFlag" : false }, "number" : { "$ref" : "#/components/schemas/DamagePhotosNumberResourceAttribute", "exampleSetFlag" : false }, "protocol" : { "$ref" : "#/components/schemas/DamagePhotosProtocolResourceAttribute", "exampleSetFlag" : false }, "vol" : { "$ref" : "#/components/schemas/DamagePhotosVolResourceAttribute", "exampleSetFlag" : false }, "filename" : { "$ref" : "#/components/schemas/DamagePhotosFilenameResourceAttribute", "exampleSetFlag" : false }, "fulltnUrl" : { "$ref" : "#/components/schemas/DamagePhotosFulltnUrlResourceAttribute", "exampleSetFlag" : false }, "host" : { "$ref" : "#/components/schemas/DamagePhotosHostResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_name" : { "$ref" : "#/components/schemas/DamagePhotosAttachment_entity_nameResourceAttribute", "exampleSetFlag" : false }, "priv" : { "$ref" : "#/components/schemas/DamagePhotosPrivResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamagePhotosPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagePhotosResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagePhotosResourcePostRelationships", "exampleSetFlag" : false } ] }, "DamagePhotosResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "filetype" : { "$ref" : "#/components/schemas/DamagePhotosFiletypeResourceAttribute", "exampleSetFlag" : false }, "volume_id" : { "$ref" : "#/components/schemas/DamagePhotosVolume_idResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_id" : { "$ref" : "#/components/schemas/DamagePhotosAttachment_entity_idResourceAttribute", "exampleSetFlag" : false }, "fullUrl" : { "$ref" : "#/components/schemas/DamagePhotosFullUrlResourceAttribute", "exampleSetFlag" : false }, "entity_table" : { "$ref" : "#/components/schemas/DamagePhotosEntity_tableResourceAttribute", "exampleSetFlag" : false }, "pk1_int" : { "$ref" : "#/components/schemas/DamagePhotosPk1_intResourceAttribute", "exampleSetFlag" : false }, "entityID" : { "$ref" : "#/components/schemas/DamagePhotosEntityIDResourceAttribute", "exampleSetFlag" : false }, "filesize" : { "$ref" : "#/components/schemas/DamagePhotosFilesizeResourceAttribute", "exampleSetFlag" : false }, "path" : { "$ref" : "#/components/schemas/DamagePhotosPathResourceAttribute", "exampleSetFlag" : false }, "number" : { "$ref" : "#/components/schemas/DamagePhotosNumberResourceAttribute", "exampleSetFlag" : false }, "protocol" : { "$ref" : "#/components/schemas/DamagePhotosProtocolResourceAttribute", "exampleSetFlag" : false }, "vol" : { "$ref" : "#/components/schemas/DamagePhotosVolResourceAttribute", "exampleSetFlag" : false }, "filename" : { "$ref" : "#/components/schemas/DamagePhotosFilenameResourceAttribute", "exampleSetFlag" : false }, "fulltnUrl" : { "$ref" : "#/components/schemas/DamagePhotosFulltnUrlResourceAttribute", "exampleSetFlag" : false }, "host" : { "$ref" : "#/components/schemas/DamagePhotosHostResourceAttribute", "exampleSetFlag" : false }, "attachment_entity_name" : { "$ref" : "#/components/schemas/DamagePhotosAttachment_entity_nameResourceAttribute", "exampleSetFlag" : false }, "priv" : { "$ref" : "#/components/schemas/DamagePhotosPrivResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "damage" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetail" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsInvestigationDetail" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentEntities" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AttachEntitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosProtocolResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosPk1_intResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagePhotosFulltnUrlResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DamagePhotosResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DamagePhotosHostResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damagePhotos/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosEntity_tableResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damagePhotos)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damagePhotos" ] }, "id" : { "$ref" : "#/components/schemas/DamagePhotosIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosFilenameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamagePhotosPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagePhotosFiletypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosEntityIDResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagePhotosInvestigationDetailResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamagePhotosVolume_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagePhotosPathResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagePhotosCmsInvestigationDetailResourceAttribute" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamagePhotosResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagePhotosResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagePhotosResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagePhotosResourceLinks", "exampleSetFlag" : false } ] }, "DamagesEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamagesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesOne_call_request_numResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesPolicyDropOffEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DamagesCountryidResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesDots_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesInvestigationVersionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DamagesStateidResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesLocator_first_nmResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DamagesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DamagesWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesZipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "DamagesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesCdi_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagesResourceLinks", "exampleSetFlag" : false } ] }, "DamagesNotified_by_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ticket_type" : { "$ref" : "#/components/schemas/DamagesTicket_typeResourceAttribute", "exampleSetFlag" : false }, "notified_by_extension" : { "$ref" : "#/components/schemas/DamagesNotified_by_extensionResourceAttribute", "exampleSetFlag" : false }, "confirmaton_date_time" : { "$ref" : "#/components/schemas/DamagesConfirmaton_date_timeResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/DamagesStateidResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/DamagesCountyResourceAttribute", "exampleSetFlag" : false }, "source" : { "$ref" : "#/components/schemas/DamagesSourceResourceAttribute", "exampleSetFlag" : false }, "add_2" : { "$ref" : "#/components/schemas/DamagesAdd_2ResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DamagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "customer_rep" : { "$ref" : "#/components/schemas/DamagesCustomer_repResourceAttribute", "exampleSetFlag" : false }, "dispatcher_id" : { "$ref" : "#/components/schemas/DamagesDispatcher_idResourceAttribute", "exampleSetFlag" : false }, "add_1" : { "$ref" : "#/components/schemas/DamagesAdd_1ResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/DamagesFacility_idResourceAttribute", "exampleSetFlag" : false }, "notified_by_email" : { "$ref" : "#/components/schemas/DamagesNotified_by_emailResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/DamagesLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/DamagesZipResourceAttribute", "exampleSetFlag" : false }, "cross_str1" : { "$ref" : "#/components/schemas/DamagesCross_str1ResourceAttribute", "exampleSetFlag" : false }, "paged_date_time" : { "$ref" : "#/components/schemas/DamagesPaged_date_timeResourceAttribute", "exampleSetFlag" : false }, "locator_first_nm" : { "$ref" : "#/components/schemas/DamagesLocator_first_nmResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/DamagesActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DamagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/DamagesCountryidResourceAttribute", "exampleSetFlag" : false }, "supgroup" : { "$ref" : "#/components/schemas/DamagesSupgroupResourceAttribute", "exampleSetFlag" : false }, "cdi_id" : { "$ref" : "#/components/schemas/DamagesCdi_idResourceAttribute", "exampleSetFlag" : false }, "notified_by_phone" : { "$ref" : "#/components/schemas/DamagesNotified_by_phoneResourceAttribute", "exampleSetFlag" : false }, "locator_last_nm" : { "$ref" : "#/components/schemas/DamagesLocator_last_nmResourceAttribute", "exampleSetFlag" : false }, "ticket_closed_date" : { "$ref" : "#/components/schemas/DamagesTicket_closed_dateResourceAttribute", "exampleSetFlag" : false }, "damage_create_date" : { "$ref" : "#/components/schemas/DamagesDamage_create_dateResourceAttribute", "exampleSetFlag" : false }, "notified_by_name" : { "$ref" : "#/components/schemas/DamagesNotified_by_nameResourceAttribute", "exampleSetFlag" : false }, "damage_date_time" : { "$ref" : "#/components/schemas/DamagesDamage_date_timeResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/DamagesSearch_textResourceAttribute", "exampleSetFlag" : false }, "cdi_confirmation" : { "$ref" : "#/components/schemas/DamagesCdi_confirmationResourceAttribute", "exampleSetFlag" : false }, "damage_reported_date" : { "$ref" : "#/components/schemas/DamagesDamage_reported_dateResourceAttribute", "exampleSetFlag" : false }, "damage_number" : { "$ref" : "#/components/schemas/DamagesDamage_numberResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/DamagesCityResourceAttribute", "exampleSetFlag" : false }, "notified_category_id" : { "$ref" : "#/components/schemas/DamagesNotified_category_idResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/DamagesLatitudeResourceAttribute", "exampleSetFlag" : false }, "caller_company" : { "$ref" : "#/components/schemas/DamagesCaller_companyResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/DamagesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_ticket_id" : { "$ref" : "#/components/schemas/DamagesOne_call_request_ticket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/DamagesExcavatorResourceAttribute", "exampleSetFlag" : false }, "excavator_id" : { "$ref" : "#/components/schemas/DamagesExcavator_idResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/DamagesLocator_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/DamagesCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "cross_str2" : { "$ref" : "#/components/schemas/DamagesCross_str2ResourceAttribute", "exampleSetFlag" : false }, "ticket_start_date" : { "$ref" : "#/components/schemas/DamagesTicket_start_dateResourceAttribute", "exampleSetFlag" : false }, "type_of_work" : { "$ref" : "#/components/schemas/DamagesType_of_workResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/DamagesTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/DamagesTicket_numberResourceAttribute", "exampleSetFlag" : false }, "caller_stmt_call_notes" : { "$ref" : "#/components/schemas/DamagesCaller_stmt_call_notesResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/DamagesBoringResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/DamagesUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_num" : { "$ref" : "#/components/schemas/DamagesOne_call_request_numResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/DamagesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/DamagesFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number_2" : { "$ref" : "#/components/schemas/DamagesCustomer_claim_number_2ResourceAttribute", "exampleSetFlag" : false }, "dots_number" : { "$ref" : "#/components/schemas/DamagesDots_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesType_of_workResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesUtility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damages" ] }, "id" : { "$ref" : "#/components/schemas/DamagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesNotified_by_phoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesNotified_by_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesClaimDetailsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DamagesDamage_date_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamagesCustomer_repResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesOne_call_request_ticket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesConfirmaton_date_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamagesExcavator_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesStateResourceAttribute" : { "$ref" : "#/components/schemas/StatesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamagesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DamagesInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : false, "exampleSetFlag" : false }, "DamagesSourceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DamagesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DamagesResourcePostAttributes", "exampleSetFlag" : false } ] }, "DamagesDamage_create_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamagesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DamagesTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DamagesCustomer_claim_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesAdd_1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesDispatcher_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesTicket_closed_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamagesCdi_confirmationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesLatitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "DamagesBoringResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "DamagesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ticket_type" : { "$ref" : "#/components/schemas/DamagesTicket_typeResourceAttribute", "exampleSetFlag" : false }, "notified_by_extension" : { "$ref" : "#/components/schemas/DamagesNotified_by_extensionResourceAttribute", "exampleSetFlag" : false }, "confirmaton_date_time" : { "$ref" : "#/components/schemas/DamagesConfirmaton_date_timeResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/DamagesStateidResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/DamagesCountyResourceAttribute", "exampleSetFlag" : false }, "source" : { "$ref" : "#/components/schemas/DamagesSourceResourceAttribute", "exampleSetFlag" : false }, "add_2" : { "$ref" : "#/components/schemas/DamagesAdd_2ResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DamagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "customer_rep" : { "$ref" : "#/components/schemas/DamagesCustomer_repResourceAttribute", "exampleSetFlag" : false }, "dispatcher_id" : { "$ref" : "#/components/schemas/DamagesDispatcher_idResourceAttribute", "exampleSetFlag" : false }, "add_1" : { "$ref" : "#/components/schemas/DamagesAdd_1ResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/DamagesFacility_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DamagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "notified_by_email" : { "$ref" : "#/components/schemas/DamagesNotified_by_emailResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/DamagesLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/DamagesZipResourceAttribute", "exampleSetFlag" : false }, "cross_str1" : { "$ref" : "#/components/schemas/DamagesCross_str1ResourceAttribute", "exampleSetFlag" : false }, "paged_date_time" : { "$ref" : "#/components/schemas/DamagesPaged_date_timeResourceAttribute", "exampleSetFlag" : false }, "geo_location" : { "$ref" : "#/components/schemas/DamagesGeo_locationResourceAttribute", "exampleSetFlag" : false }, "locator_first_nm" : { "$ref" : "#/components/schemas/DamagesLocator_first_nmResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/DamagesActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DamagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/DamagesCountryidResourceAttribute", "exampleSetFlag" : false }, "supgroup" : { "$ref" : "#/components/schemas/DamagesSupgroupResourceAttribute", "exampleSetFlag" : false }, "cdi_id" : { "$ref" : "#/components/schemas/DamagesCdi_idResourceAttribute", "exampleSetFlag" : false }, "notified_by_phone" : { "$ref" : "#/components/schemas/DamagesNotified_by_phoneResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/DamagesCreated_onResourceAttribute", "exampleSetFlag" : false }, "locator_last_nm" : { "$ref" : "#/components/schemas/DamagesLocator_last_nmResourceAttribute", "exampleSetFlag" : false }, "ticket_closed_date" : { "$ref" : "#/components/schemas/DamagesTicket_closed_dateResourceAttribute", "exampleSetFlag" : false }, "damage_create_date" : { "$ref" : "#/components/schemas/DamagesDamage_create_dateResourceAttribute", "exampleSetFlag" : false }, "notified_by_name" : { "$ref" : "#/components/schemas/DamagesNotified_by_nameResourceAttribute", "exampleSetFlag" : false }, "damage_date_time" : { "$ref" : "#/components/schemas/DamagesDamage_date_timeResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/DamagesSearch_textResourceAttribute", "exampleSetFlag" : false }, "cdi_confirmation" : { "$ref" : "#/components/schemas/DamagesCdi_confirmationResourceAttribute", "exampleSetFlag" : false }, "damage_reported_date" : { "$ref" : "#/components/schemas/DamagesDamage_reported_dateResourceAttribute", "exampleSetFlag" : false }, "damage_number" : { "$ref" : "#/components/schemas/DamagesDamage_numberResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/DamagesCityResourceAttribute", "exampleSetFlag" : false }, "notified_category_id" : { "$ref" : "#/components/schemas/DamagesNotified_category_idResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/DamagesLatitudeResourceAttribute", "exampleSetFlag" : false }, "caller_company" : { "$ref" : "#/components/schemas/DamagesCaller_companyResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/DamagesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_ticket_id" : { "$ref" : "#/components/schemas/DamagesOne_call_request_ticket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/DamagesExcavatorResourceAttribute", "exampleSetFlag" : false }, "excavator_id" : { "$ref" : "#/components/schemas/DamagesExcavator_idResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/DamagesLocator_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/DamagesCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "cross_str2" : { "$ref" : "#/components/schemas/DamagesCross_str2ResourceAttribute", "exampleSetFlag" : false }, "ticket_start_date" : { "$ref" : "#/components/schemas/DamagesTicket_start_dateResourceAttribute", "exampleSetFlag" : false }, "type_of_work" : { "$ref" : "#/components/schemas/DamagesType_of_workResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/DamagesTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/DamagesTicket_numberResourceAttribute", "exampleSetFlag" : false }, "caller_stmt_call_notes" : { "$ref" : "#/components/schemas/DamagesCaller_stmt_call_notesResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/DamagesBoringResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/DamagesUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_num" : { "$ref" : "#/components/schemas/DamagesOne_call_request_numResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/DamagesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/DamagesFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number_2" : { "$ref" : "#/components/schemas/DamagesCustomer_claim_number_2ResourceAttribute", "exampleSetFlag" : false }, "dots_number" : { "$ref" : "#/components/schemas/DamagesDots_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesNotified_category_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesCaller_stmt_call_notesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesAdd_2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamagesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesLegalDamagesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DamagesCross_str1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesDamage_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesDamage_reported_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamagesGeo_locationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesFacility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ticket_type" : { "$ref" : "#/components/schemas/DamagesTicket_typeResourceAttribute", "exampleSetFlag" : false }, "notified_by_extension" : { "$ref" : "#/components/schemas/DamagesNotified_by_extensionResourceAttribute", "exampleSetFlag" : false }, "confirmaton_date_time" : { "$ref" : "#/components/schemas/DamagesConfirmaton_date_timeResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/DamagesStateidResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/DamagesCountyResourceAttribute", "exampleSetFlag" : false }, "source" : { "$ref" : "#/components/schemas/DamagesSourceResourceAttribute", "exampleSetFlag" : false }, "add_2" : { "$ref" : "#/components/schemas/DamagesAdd_2ResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DamagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "customer_rep" : { "$ref" : "#/components/schemas/DamagesCustomer_repResourceAttribute", "exampleSetFlag" : false }, "dispatcher_id" : { "$ref" : "#/components/schemas/DamagesDispatcher_idResourceAttribute", "exampleSetFlag" : false }, "add_1" : { "$ref" : "#/components/schemas/DamagesAdd_1ResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/DamagesFacility_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DamagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "notified_by_email" : { "$ref" : "#/components/schemas/DamagesNotified_by_emailResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/DamagesLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/DamagesZipResourceAttribute", "exampleSetFlag" : false }, "cross_str1" : { "$ref" : "#/components/schemas/DamagesCross_str1ResourceAttribute", "exampleSetFlag" : false }, "paged_date_time" : { "$ref" : "#/components/schemas/DamagesPaged_date_timeResourceAttribute", "exampleSetFlag" : false }, "locator_first_nm" : { "$ref" : "#/components/schemas/DamagesLocator_first_nmResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/DamagesActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DamagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/DamagesCountryidResourceAttribute", "exampleSetFlag" : false }, "supgroup" : { "$ref" : "#/components/schemas/DamagesSupgroupResourceAttribute", "exampleSetFlag" : false }, "cdi_id" : { "$ref" : "#/components/schemas/DamagesCdi_idResourceAttribute", "exampleSetFlag" : false }, "notified_by_phone" : { "$ref" : "#/components/schemas/DamagesNotified_by_phoneResourceAttribute", "exampleSetFlag" : false }, "locator_last_nm" : { "$ref" : "#/components/schemas/DamagesLocator_last_nmResourceAttribute", "exampleSetFlag" : false }, "ticket_closed_date" : { "$ref" : "#/components/schemas/DamagesTicket_closed_dateResourceAttribute", "exampleSetFlag" : false }, "damage_create_date" : { "$ref" : "#/components/schemas/DamagesDamage_create_dateResourceAttribute", "exampleSetFlag" : false }, "notified_by_name" : { "$ref" : "#/components/schemas/DamagesNotified_by_nameResourceAttribute", "exampleSetFlag" : false }, "damage_date_time" : { "$ref" : "#/components/schemas/DamagesDamage_date_timeResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/DamagesSearch_textResourceAttribute", "exampleSetFlag" : false }, "cdi_confirmation" : { "$ref" : "#/components/schemas/DamagesCdi_confirmationResourceAttribute", "exampleSetFlag" : false }, "damage_reported_date" : { "$ref" : "#/components/schemas/DamagesDamage_reported_dateResourceAttribute", "exampleSetFlag" : false }, "damage_number" : { "$ref" : "#/components/schemas/DamagesDamage_numberResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/DamagesCityResourceAttribute", "exampleSetFlag" : false }, "notified_category_id" : { "$ref" : "#/components/schemas/DamagesNotified_category_idResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/DamagesLatitudeResourceAttribute", "exampleSetFlag" : false }, "caller_company" : { "$ref" : "#/components/schemas/DamagesCaller_companyResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/DamagesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_ticket_id" : { "$ref" : "#/components/schemas/DamagesOne_call_request_ticket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/DamagesExcavatorResourceAttribute", "exampleSetFlag" : false }, "excavator_id" : { "$ref" : "#/components/schemas/DamagesExcavator_idResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/DamagesLocator_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/DamagesCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "cross_str2" : { "$ref" : "#/components/schemas/DamagesCross_str2ResourceAttribute", "exampleSetFlag" : false }, "ticket_start_date" : { "$ref" : "#/components/schemas/DamagesTicket_start_dateResourceAttribute", "exampleSetFlag" : false }, "type_of_work" : { "$ref" : "#/components/schemas/DamagesType_of_workResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/DamagesTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/DamagesTicket_numberResourceAttribute", "exampleSetFlag" : false }, "caller_stmt_call_notes" : { "$ref" : "#/components/schemas/DamagesCaller_stmt_call_notesResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/DamagesBoringResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/DamagesUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_num" : { "$ref" : "#/components/schemas/DamagesOne_call_request_numResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/DamagesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/DamagesFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number_2" : { "$ref" : "#/components/schemas/DamagesCustomer_claim_number_2ResourceAttribute", "exampleSetFlag" : false }, "dots_number" : { "$ref" : "#/components/schemas/DamagesDots_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesSearch_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesDamagePhotosResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DamagesCaller_companyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "policyDropOffEstimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/policyDropOffEstimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/policyDropOffEstimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claimDetails" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/claimDetails" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/claimDetails" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "damageListings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/damageListings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/damageListings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageListingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageListingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "district" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/district" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/district" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationVersions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/investigationVersions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/investigationVersions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claims" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/claims" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/claims" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalDamages" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/legalDamages" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/legalDamages" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "state" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/state" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/state" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "damagePhotos" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/relationships/damagePhotos" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/damages/{id}/damagePhotos" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesTicket_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamagesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (damages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "damages" ] }, "id" : { "$ref" : "#/components/schemas/DamagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesTicket_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesPaged_date_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DamagesTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesSupgroupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesDamageListingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamageListingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DamagesExcavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesLongitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "DamagesDistrictResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DamagesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DamagesLocator_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesCross_str2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesCustomer_claim_number_2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesFacility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesLocator_last_nmResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DamagesNotified_by_extensionResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DamagesClaimsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DeletionTypesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (deletionTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "deletionTypes" ] }, "id" : { "$ref" : "#/components/schemas/DeletionTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeletionTypesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DeletionTypesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DeletionTypesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (deletionTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "deletionTypes" ] }, "id" : { "$ref" : "#/components/schemas/DeletionTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DeletionTypesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeletionTypesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DeletionTypesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeletionTypesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeletionTypesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeletionTypesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/DeletionTypesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DeletionTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/DeletionTypesNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/DeletionTypesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/DeletionTypesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/DeletionTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DeletionTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DeletionTypesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DeletionTypesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DeletionTypesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeletionTypesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/DeletionTypesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DeletionTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/DeletionTypesNotesResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/DeletionTypesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/DeletionTypesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/DeletionTypesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/DeletionTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DeletionTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DeletionTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DeletionTypesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DeletionTypesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeletionTypesResourcePostAttributes", "exampleSetFlag" : false } ] }, "DeletionTypesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DeletionTypesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/deletionTypes/{id}/relationships/assets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/deletionTypes/{id}/assets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/DeletionTypesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DeletionTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/DeletionTypesNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/DeletionTypesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/DeletionTypesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/DeletionTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DeletionTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DeletionTypesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeletionTypesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeletionTypesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeletionTypesResourceLinks", "exampleSetFlag" : false } ] }, "DeletionTypesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeletionTypesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DeletionTypesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeletionTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/deletionTypes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DeletionTypesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeviceTokensCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DeviceTokensResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/deviceTokens/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeviceTokensResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeviceTokensDevice_tokenResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeviceTokensPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DeviceTokensPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/deviceTokens/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/deviceTokens/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DeviceTokensResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DeviceTokensResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeviceTokensResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeviceTokensResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeviceTokensResourceLinks", "exampleSetFlag" : false } ] }, "DeviceTokensAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeviceTokensPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (deviceTokens)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "deviceTokens" ] }, "id" : { "$ref" : "#/components/schemas/DeviceTokensIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "attribute5" : { "$ref" : "#/components/schemas/DeviceTokensAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/DeviceTokensAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/DeviceTokensEmployee_idResourceAttribute", "exampleSetFlag" : false }, "device_token" : { "$ref" : "#/components/schemas/DeviceTokensDevice_tokenResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/DeviceTokensAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/DeviceTokensAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DeviceTokensLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/DeviceTokensAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeviceTokensLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DeviceTokensResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DeviceTokensEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DeviceTokensResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (deviceTokens)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "deviceTokens" ] }, "id" : { "$ref" : "#/components/schemas/DeviceTokensIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "attribute5" : { "$ref" : "#/components/schemas/DeviceTokensAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/DeviceTokensAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/DeviceTokensCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/DeviceTokensEmployee_idResourceAttribute", "exampleSetFlag" : false }, "device_token" : { "$ref" : "#/components/schemas/DeviceTokensDevice_tokenResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/DeviceTokensAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/DeviceTokensAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DeviceTokensLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/DeviceTokensAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DeviceTokensPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DeviceTokensResourcePostAttributes", "exampleSetFlag" : false } ] }, "DeviceTokensAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DeviceTokensEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DeviceTokensResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "attribute5" : { "$ref" : "#/components/schemas/DeviceTokensAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/DeviceTokensAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/DeviceTokensEmployee_idResourceAttribute", "exampleSetFlag" : false }, "device_token" : { "$ref" : "#/components/schemas/DeviceTokensDevice_tokenResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/DeviceTokensAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/DeviceTokensAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/DeviceTokensAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DeviceTokensResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DeviceTokensAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DigAreasPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DigAreasPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/digAreas/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DigAreasPostResourceReference", "exampleSetFlag" : false } ] }, "DigAreasResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "order_number" : { "$ref" : "#/components/schemas/DigAreasOrder_numberResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/DigAreasLonResourceAttribute", "exampleSetFlag" : false }, "transmission_id" : { "$ref" : "#/components/schemas/DigAreasTransmission_idResourceAttribute", "exampleSetFlag" : false }, "group_index" : { "$ref" : "#/components/schemas/DigAreasGroup_indexResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/DigAreasLatResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasIdResourceAttribute" : { "type" : "object", "properties" : { "transmission_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "order_number" : { "type" : "integer", "format" : "int32", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "DigAreasPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DigAreasPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasTransmission_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DigAreasResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (digAreas)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "digAreas" ] }, "id" : { "$ref" : "#/components/schemas/DigAreasIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DigAreasResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasGroup_indexResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DigAreasResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DigAreasResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DigAreasResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DigAreasResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DigAreasResourceLinks", "exampleSetFlag" : false } ] }, "DigAreasLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "DigAreasResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "transmissionDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/digAreas/{id}/relationships/transmissionDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/digAreas/{id}/transmissionDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasOrder_numberResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DigAreasPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (digAreas)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "digAreas" ] }, "id" : { "$ref" : "#/components/schemas/DigAreasIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DigAreasResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DigAreasTransmissionDetailResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DigAreasResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DigAreasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DigAreasResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DigAreasResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DigAreasResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DistrictBoundariesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DistrictBoundariesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictBoundariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DistrictBoundariesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictBoundariesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictBoundariesResourceLinks", "exampleSetFlag" : false } ] }, "DistrictBoundariesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DistrictBoundariesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (districtBoundaries)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "districtBoundaries" ] }, "id" : { "$ref" : "#/components/schemas/DistrictBoundariesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (districtBoundaries)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "districtBoundaries" ] }, "id" : { "$ref" : "#/components/schemas/DistrictBoundariesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DistrictBoundariesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictBoundariesResourcePostAttributes", "exampleSetFlag" : false } ] }, "DistrictBoundariesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictBoundariesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DistrictBoundariesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "distric_name" : { "$ref" : "#/components/schemas/DistrictBoundariesDistric_nameResourceAttribute", "exampleSetFlag" : false }, "color" : { "$ref" : "#/components/schemas/DistrictBoundariesColorResourceAttribute", "exampleSetFlag" : false }, "boundaries" : { "$ref" : "#/components/schemas/DistrictBoundariesBoundariesResourceAttribute", "exampleSetFlag" : false }, "contact_info" : { "$ref" : "#/components/schemas/DistrictBoundariesContact_infoResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesContact_infoResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictBoundariesDistric_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictBoundariesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "distric_name" : { "$ref" : "#/components/schemas/DistrictBoundariesDistric_nameResourceAttribute", "exampleSetFlag" : false }, "color" : { "$ref" : "#/components/schemas/DistrictBoundariesColorResourceAttribute", "exampleSetFlag" : false }, "boundaries" : { "$ref" : "#/components/schemas/DistrictBoundariesBoundariesResourceAttribute", "exampleSetFlag" : false }, "contact_info" : { "$ref" : "#/components/schemas/DistrictBoundariesContact_infoResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesColorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictBoundariesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DistrictBoundariesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictBoundariesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DistrictBoundariesBoundariesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictBoundariesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictBoundariesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "distric_name" : { "$ref" : "#/components/schemas/DistrictBoundariesDistric_nameResourceAttribute", "exampleSetFlag" : false }, "color" : { "$ref" : "#/components/schemas/DistrictBoundariesColorResourceAttribute", "exampleSetFlag" : false }, "boundaries" : { "$ref" : "#/components/schemas/DistrictBoundariesBoundariesResourceAttribute", "exampleSetFlag" : false }, "contact_info" : { "$ref" : "#/components/schemas/DistrictBoundariesContact_infoResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/districtBoundaries/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictBoundariesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DistrictBoundariesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DistrictLocationsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/DistrictLocationsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DistrictLocationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/DistrictLocationsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/DistrictLocationsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DistrictLocationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "location_id" : { "$ref" : "#/components/schemas/DistrictLocationsLocation_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DistrictLocationsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DistrictLocationsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictLocationsResourcePostAttributes", "exampleSetFlag" : false } ] }, "DistrictLocationsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DistrictLocationsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictLocationsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DistrictLocationsDistResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DistrictLocationsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "dist" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/districtLocations/{id}/relationships/dist" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/districtLocations/{id}/dist" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "location" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/districtLocations/{id}/relationships/location" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/districtLocations/{id}/location" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictLocationsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictLocationsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictLocationsResourceLinks", "exampleSetFlag" : false } ] }, "DistrictLocationsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DistrictLocationsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictLocationsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (districtLocations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "districtLocations" ] }, "id" : { "$ref" : "#/components/schemas/DistrictLocationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictLocationsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictLocationsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/DistrictLocationsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DistrictLocationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/DistrictLocationsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DistrictLocationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/DistrictLocationsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DistrictLocationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "location_id" : { "$ref" : "#/components/schemas/DistrictLocationsLocation_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/districtLocations/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (districtLocations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "districtLocations" ] }, "id" : { "$ref" : "#/components/schemas/DistrictLocationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictLocationsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DistrictLocationsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DistrictLocationsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictLocationsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DistrictLocationsLocationResourceAttribute" : { "$ref" : "#/components/schemas/LocationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DistrictLocationsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DistrictLocationsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DistrictLocationsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "DistrictLocationsLocation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DistrictLocationsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictLocationsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/DistrictLocationsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DistrictLocationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "location_id" : { "$ref" : "#/components/schemas/DistrictLocationsLocation_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DistrictLocationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/DistrictLocationsCreated_onResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/DistrictLocationsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DistrictLocationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/DistrictLocationsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/DistrictLocationsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictLocationsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictLocationsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsDistrict_manager_employee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DistrictsLocationsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DistrictsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DistrictsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DistrictsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictsSupervisorGroupsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DistrictsDistrict_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DistrictsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DistrictsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictsResourcePostRelationships", "exampleSetFlag" : false } ] }, "DistrictsDistrict_codeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DistrictsEmployeesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DistrictsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/relationships/assets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/assets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "districtLocations" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/relationships/districtLocations" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/districtLocations" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesOnLoans" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/relationships/employeesOnLoans" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/employeesOnLoans" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supervisorGroups" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/relationships/supervisorGroups" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/supervisorGroups" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locations" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/relationships/locations" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/locations" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employees" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/relationships/employees" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/employees" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userDataAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/relationships/userDataAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/userDataAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesActiveNoAssets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/relationships/employeesActiveNoAssets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}/employeesActiveNoAssets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DistrictsDistrictLocationsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DistrictsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (districts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "districts" ] }, "id" : { "$ref" : "#/components/schemas/DistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsDistrict_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (districts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "districts" ] }, "id" : { "$ref" : "#/components/schemas/DistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/DistrictsDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DistrictsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "district_abbr" : { "$ref" : "#/components/schemas/DistrictsDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "district_code" : { "$ref" : "#/components/schemas/DistrictsDistrict_codeResourceAttribute", "exampleSetFlag" : false }, "workday_id" : { "$ref" : "#/components/schemas/DistrictsWorkday_idResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/DistrictsStateResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/DistrictsRegionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DistrictsCreated_byResourceAttribute", "exampleSetFlag" : false }, "district_manager_employee_id" : { "$ref" : "#/components/schemas/DistrictsDistrict_manager_employee_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "districtLocations" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesOnLoans" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supervisorGroups" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locations" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employees" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userDataAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesActiveNoAssets" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "DistrictsWorkday_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DistrictsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "districtLocations" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesOnLoans" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supervisorGroups" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locations" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employees" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userDataAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesActiveNoAssets" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsEmployeesActiveNoAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DistrictsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/districts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictsAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DistrictsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DistrictsUserDataAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DistrictsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/DistrictsDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DistrictsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "district_abbr" : { "$ref" : "#/components/schemas/DistrictsDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "district_code" : { "$ref" : "#/components/schemas/DistrictsDistrict_codeResourceAttribute", "exampleSetFlag" : false }, "workday_id" : { "$ref" : "#/components/schemas/DistrictsWorkday_idResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/DistrictsStateResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/DistrictsRegionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DistrictsCreated_byResourceAttribute", "exampleSetFlag" : false }, "district_manager_employee_id" : { "$ref" : "#/components/schemas/DistrictsDistrict_manager_employee_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DistrictsResourceLinks", "exampleSetFlag" : false } ] }, "DistrictsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DistrictsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsEmployeesOnLoansResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "DistrictsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/DistrictsDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/DistrictsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "district_abbr" : { "$ref" : "#/components/schemas/DistrictsDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/DistrictsCreated_onResourceAttribute", "exampleSetFlag" : false }, "district_code" : { "$ref" : "#/components/schemas/DistrictsDistrict_codeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/DistrictsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "workday_id" : { "$ref" : "#/components/schemas/DistrictsWorkday_idResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/DistrictsStateResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/DistrictsRegionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/DistrictsCreated_byResourceAttribute", "exampleSetFlag" : false }, "district_manager_employee_id" : { "$ref" : "#/components/schemas/DistrictsDistrict_manager_employee_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DistrictsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DueDateExtensionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "DueDateExtensionsUsr_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DueDateExtensionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (dueDateExtensions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "dueDateExtensions" ] }, "id" : { "$ref" : "#/components/schemas/DueDateExtensionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DueDateExtensionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DueDateExtensionsPostResourceReference", "exampleSetFlag" : false } ] }, "DueDateExtensionsApproved_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DueDateExtensionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (dueDateExtensions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "dueDateExtensions" ] }, "id" : { "$ref" : "#/components/schemas/DueDateExtensionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DueDateExtensionsTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DueDateExtensionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DueDateExtensionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "DueDateExtensionsOld_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DueDateExtensionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/dueDateExtensions/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/dueDateExtensions/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "usr" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/dueDateExtensions/{id}/relationships/usr" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/dueDateExtensions/{id}/usr" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "visit" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/dueDateExtensions/{id}/relationships/visit" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/dueDateExtensions/{id}/visit" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "DueDateExtensionsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DueDateExtensionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/dueDateExtensions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "DueDateExtensionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DueDateExtensionsVisitResourceAttribute" : { "$ref" : "#/components/schemas/VisitsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DueDateExtensionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "approver_phone" : { "$ref" : "#/components/schemas/DueDateExtensionsApprover_phoneResourceAttribute", "exampleSetFlag" : false }, "reason" : { "$ref" : "#/components/schemas/DueDateExtensionsReasonResourceAttribute", "exampleSetFlag" : false }, "approved_by" : { "$ref" : "#/components/schemas/DueDateExtensionsApproved_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/DueDateExtensionsNotesResourceAttribute", "exampleSetFlag" : false }, "usr_id" : { "$ref" : "#/components/schemas/DueDateExtensionsUsr_idResourceAttribute", "exampleSetFlag" : false }, "when_extended" : { "$ref" : "#/components/schemas/DueDateExtensionsWhen_extendedResourceAttribute", "exampleSetFlag" : false }, "due_date" : { "$ref" : "#/components/schemas/DueDateExtensionsDue_dateResourceAttribute", "exampleSetFlag" : false }, "old_due_date" : { "$ref" : "#/components/schemas/DueDateExtensionsOld_due_dateResourceAttribute", "exampleSetFlag" : false }, "when_entered" : { "$ref" : "#/components/schemas/DueDateExtensionsWhen_enteredResourceAttribute", "exampleSetFlag" : false }, "visit_id" : { "$ref" : "#/components/schemas/DueDateExtensionsVisit_idResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/DueDateExtensionsTicket_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DueDateExtensionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DueDateExtensionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DueDateExtensionsNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DueDateExtensionsVisit_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DueDateExtensionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DueDateExtensionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DueDateExtensionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/DueDateExtensionsResourceLinks", "exampleSetFlag" : false } ] }, "DueDateExtensionsWhen_extendedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DueDateExtensionsReasonResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DueDateExtensionsApprover_phoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DueDateExtensionsUsrResourceAttribute" : { "$ref" : "#/components/schemas/UsrsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "DueDateExtensionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "DueDateExtensionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "DueDateExtensionsWhen_enteredResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DueDateExtensionsDue_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "DueDateExtensionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesDelivery_attemptsResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeeMessagesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "delivery_detail" : { "$ref" : "#/components/schemas/EmployeeMessagesDelivery_detailResourceAttribute", "exampleSetFlag" : false }, "reference_id" : { "$ref" : "#/components/schemas/EmployeeMessagesReference_idResourceAttribute", "exampleSetFlag" : false }, "delivery_attempts" : { "$ref" : "#/components/schemas/EmployeeMessagesDelivery_attemptsResourceAttribute", "exampleSetFlag" : false }, "channel" : { "$ref" : "#/components/schemas/EmployeeMessagesChannelResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EmployeeMessagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/EmployeeMessagesStatus_idResourceAttribute", "exampleSetFlag" : false }, "claimed_at" : { "$ref" : "#/components/schemas/EmployeeMessagesClaimed_atResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/EmployeeMessagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "last_read_at" : { "$ref" : "#/components/schemas/EmployeeMessagesLast_read_atResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/EmployeeMessagesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "recipient_email" : { "$ref" : "#/components/schemas/EmployeeMessagesRecipient_emailResourceAttribute", "exampleSetFlag" : false }, "message_id" : { "$ref" : "#/components/schemas/EmployeeMessagesMessage_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EmployeeMessagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "sent_at" : { "$ref" : "#/components/schemas/EmployeeMessagesSent_atResourceAttribute", "exampleSetFlag" : false }, "schedulerInfo" : { "$ref" : "#/components/schemas/EmployeeMessagesSchedulerInfoResourceAttribute", "exampleSetFlag" : false }, "first_read_at" : { "$ref" : "#/components/schemas/EmployeeMessagesFirst_read_atResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/EmployeeMessagesCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/EmployeeMessagesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/EmployeeMessagesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "cleared_at" : { "$ref" : "#/components/schemas/EmployeeMessagesCleared_atResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "acknowledged_at" : { "$ref" : "#/components/schemas/EmployeeMessagesAcknowledged_atResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/EmployeeMessagesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "reference_id" : { "$ref" : "#/components/schemas/EmployeeMessagesReference_idResourceAttribute", "exampleSetFlag" : false }, "message_id" : { "$ref" : "#/components/schemas/EmployeeMessagesMessage_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EmployeeMessagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "sent_at" : { "$ref" : "#/components/schemas/EmployeeMessagesSent_atResourceAttribute", "exampleSetFlag" : false }, "schedulerInfo" : { "$ref" : "#/components/schemas/EmployeeMessagesSchedulerInfoResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EmployeeMessagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/EmployeeMessagesStatus_idResourceAttribute", "exampleSetFlag" : false }, "first_read_at" : { "$ref" : "#/components/schemas/EmployeeMessagesFirst_read_atResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/EmployeeMessagesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/EmployeeMessagesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "cleared_at" : { "$ref" : "#/components/schemas/EmployeeMessagesCleared_atResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/EmployeeMessagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "last_read_at" : { "$ref" : "#/components/schemas/EmployeeMessagesLast_read_atResourceAttribute", "exampleSetFlag" : false }, "acknowledged_at" : { "$ref" : "#/components/schemas/EmployeeMessagesAcknowledged_atResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employeeMessages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employeeMessages" ] }, "id" : { "$ref" : "#/components/schemas/EmployeeMessagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesSent_atResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesStatus_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeeMessagesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeeMessagesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "status" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesSchedulerInfoResourceAttribute" : { "type" : "object", "properties" : { "cron_expression" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "time_zone" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "repeat_time" : { "type" : "integer", "format" : "int32", "exampleSetFlag" : false, "types" : [ "integer" ] }, "start_date" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "end_date" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "employeeId" : { "type" : "integer", "format" : "int32", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "nullable" : true, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeeMessagesReference_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "messageWithCount" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/employeeMessages/{id}/relationships/messageWithCount" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/employeeMessages/{id}/messageWithCount" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/MessagesWithCountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/employeeMessages/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/employeeMessages/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "message" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/employeeMessages/{id}/relationships/message" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/employeeMessages/{id}/message" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "status" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/employeeMessages/{id}/relationships/status" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/employeeMessages/{id}/status" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesAcknowledged_atResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeeMessagesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeeMessagesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesCleared_atResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesMessage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeeMessagesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesMessageWithCountResourceAttribute" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeeMessagesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "EmployeeMessagesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeeMessagesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeeMessagesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeeMessagesResourceLinks", "exampleSetFlag" : false } ] }, "EmployeeMessagesClaimed_atResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesFirst_read_atResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeeMessagesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeeMessagesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeeMessagesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeeMessagesResourcePostRelationships", "exampleSetFlag" : false } ] }, "EmployeeMessagesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesChannelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employeeMessages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employeeMessages" ] }, "id" : { "$ref" : "#/components/schemas/EmployeeMessagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesMessageResourceAttribute" : { "$ref" : "#/components/schemas/MessagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesRecipient_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/employeeMessages/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/EmployeeMessagesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "reference_id" : { "$ref" : "#/components/schemas/EmployeeMessagesReference_idResourceAttribute", "exampleSetFlag" : false }, "message_id" : { "$ref" : "#/components/schemas/EmployeeMessagesMessage_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EmployeeMessagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "sent_at" : { "$ref" : "#/components/schemas/EmployeeMessagesSent_atResourceAttribute", "exampleSetFlag" : false }, "schedulerInfo" : { "$ref" : "#/components/schemas/EmployeeMessagesSchedulerInfoResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EmployeeMessagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/EmployeeMessagesStatus_idResourceAttribute", "exampleSetFlag" : false }, "first_read_at" : { "$ref" : "#/components/schemas/EmployeeMessagesFirst_read_atResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/EmployeeMessagesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/EmployeeMessagesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "cleared_at" : { "$ref" : "#/components/schemas/EmployeeMessagesCleared_atResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/EmployeeMessagesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "last_read_at" : { "$ref" : "#/components/schemas/EmployeeMessagesLast_read_atResourceAttribute", "exampleSetFlag" : false }, "acknowledged_at" : { "$ref" : "#/components/schemas/EmployeeMessagesAcknowledged_atResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "EmployeeMessagesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeeMessagesIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesDelivery_detailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeeMessagesStatusResourceAttribute" : { "$ref" : "#/components/schemas/StatusesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesLast_read_atResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeeMessagesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "status" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesDeviceTokensResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesSup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesVehiclesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAssignments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/assetAssignments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/assetAssignments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locatorCheckins" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/locatorCheckins" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/locatorCheckins" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assignments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/assignments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/assignments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "comments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/comments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/comments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/dist" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/dist" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "vehicles" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/vehicles" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/vehicles" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "deviceTokens" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/deviceTokens" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/deviceTokens" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigations" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/investigations" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/investigations" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ideas" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/ideas" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/ideas" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "requests" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/requests" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/requests" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "acceptedAssets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/acceptedAssets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/acceptedAssets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userDataAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/userDataAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/userDataAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supgroup" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/supgroup" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/supgroup" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "wirelessInventories" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/wirelessInventories" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/wirelessInventories" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeeMessages" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/employeeMessages" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/employeeMessages" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "messages" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/messages" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/messages" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "schedulerJobsInfo" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/schedulerJobsInfo" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/schedulerJobsInfo" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "announcements" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/relationships/announcements" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}/announcements" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesEstimated_return_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAssignments" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locatorCheckins" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assignments" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "vehicles" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "deviceTokens" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "requests" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userDataAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supgroup" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeeMessages" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "messages" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "schedulerJobsInfo" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "announcements" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesLegal_name_lastResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesAcceptedAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesEff_sup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesReasonResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesJob_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesIdeasResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesLegal_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employees)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employees" ] }, "id" : { "$ref" : "#/components/schemas/EmployeesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesEff_sup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesDisplay_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "EmployeesEff_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesLegal_name_firstResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesDistResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeesEff_regionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesEff_sup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesAssetAssignmentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesRequestsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesEmailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesAnnouncementsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesDistrictResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesEffective_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeesEmployeeMessagesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesSupgroupResourceAttribute" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeesPositionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeesMessagesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAssignments" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locatorCheckins" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assignments" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "vehicles" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "deviceTokens" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DeviceTokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "requests" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userDataAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supgroup" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeeMessages" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "messages" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "schedulerJobsInfo" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "announcements" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AnnouncementsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesSup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActive_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesExclusion_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "reason" : { "$ref" : "#/components/schemas/EmployeesReasonResourceAttribute", "exampleSetFlag" : false }, "estimated_return_date" : { "$ref" : "#/components/schemas/EmployeesEstimated_return_dateResourceAttribute", "exampleSetFlag" : false }, "district_abbr" : { "$ref" : "#/components/schemas/EmployeesDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesSup_emp_idResourceAttribute", "exampleSetFlag" : false }, "exclusion_code" : { "$ref" : "#/components/schemas/EmployeesExclusion_codeResourceAttribute", "exampleSetFlag" : false }, "eff_district_abbr" : { "$ref" : "#/components/schemas/EmployeesEff_district_abbrResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EmployeesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_code" : { "$ref" : "#/components/schemas/EmployeesEff_sup_group_codeResourceAttribute", "exampleSetFlag" : false }, "legal_name_last" : { "$ref" : "#/components/schemas/EmployeesLegal_name_lastResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/EmployeesEffective_dateResourceAttribute", "exampleSetFlag" : false }, "action" : { "$ref" : "#/components/schemas/EmployeesActionResourceAttribute", "exampleSetFlag" : false }, "legal_name" : { "$ref" : "#/components/schemas/EmployeesLegal_nameResourceAttribute", "exampleSetFlag" : false }, "job_code" : { "$ref" : "#/components/schemas/EmployeesJob_codeResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/EmployeesStateResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/EmployeesEmailResourceAttribute", "exampleSetFlag" : false }, "eff_region" : { "$ref" : "#/components/schemas/EmployeesEff_regionResourceAttribute", "exampleSetFlag" : false }, "sup_group_id" : { "$ref" : "#/components/schemas/EmployeesSup_group_idResourceAttribute", "exampleSetFlag" : false }, "legal_name_first" : { "$ref" : "#/components/schemas/EmployeesLegal_name_firstResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/EmployeesDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "eff_state" : { "$ref" : "#/components/schemas/EmployeesEff_stateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EmployeesCreated_byResourceAttribute", "exampleSetFlag" : false }, "active_status" : { "$ref" : "#/components/schemas/EmployeesActive_statusResourceAttribute", "exampleSetFlag" : false }, "eff_supervisor" : { "$ref" : "#/components/schemas/EmployeesEff_supervisorResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/EmployeesDistrictResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_id" : { "$ref" : "#/components/schemas/EmployeesEff_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "eff_district_id" : { "$ref" : "#/components/schemas/EmployeesEff_district_idResourceAttribute", "exampleSetFlag" : false }, "position" : { "$ref" : "#/components/schemas/EmployeesPositionResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/EmployeesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "emp_type" : { "$ref" : "#/components/schemas/EmployeesEmp_typeResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/EmployeesRegionResourceAttribute", "exampleSetFlag" : false }, "eff_sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesEff_sup_emp_idResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/EmployeesSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "supervisor" : { "$ref" : "#/components/schemas/EmployeesSupervisorResourceAttribute", "exampleSetFlag" : false }, "eff_district" : { "$ref" : "#/components/schemas/EmployeesEff_districtResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/EmployeesEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesEmp_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeesAssignmentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesLocatorCheckinsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "reason" : { "$ref" : "#/components/schemas/EmployeesReasonResourceAttribute", "exampleSetFlag" : false }, "estimated_return_date" : { "$ref" : "#/components/schemas/EmployeesEstimated_return_dateResourceAttribute", "exampleSetFlag" : false }, "district_abbr" : { "$ref" : "#/components/schemas/EmployeesDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesSup_emp_idResourceAttribute", "exampleSetFlag" : false }, "exclusion_code" : { "$ref" : "#/components/schemas/EmployeesExclusion_codeResourceAttribute", "exampleSetFlag" : false }, "eff_district_abbr" : { "$ref" : "#/components/schemas/EmployeesEff_district_abbrResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EmployeesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_code" : { "$ref" : "#/components/schemas/EmployeesEff_sup_group_codeResourceAttribute", "exampleSetFlag" : false }, "legal_name_last" : { "$ref" : "#/components/schemas/EmployeesLegal_name_lastResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/EmployeesEffective_dateResourceAttribute", "exampleSetFlag" : false }, "action" : { "$ref" : "#/components/schemas/EmployeesActionResourceAttribute", "exampleSetFlag" : false }, "legal_name" : { "$ref" : "#/components/schemas/EmployeesLegal_nameResourceAttribute", "exampleSetFlag" : false }, "job_code" : { "$ref" : "#/components/schemas/EmployeesJob_codeResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/EmployeesStateResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/EmployeesEmailResourceAttribute", "exampleSetFlag" : false }, "eff_region" : { "$ref" : "#/components/schemas/EmployeesEff_regionResourceAttribute", "exampleSetFlag" : false }, "sup_group_id" : { "$ref" : "#/components/schemas/EmployeesSup_group_idResourceAttribute", "exampleSetFlag" : false }, "legal_name_first" : { "$ref" : "#/components/schemas/EmployeesLegal_name_firstResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/EmployeesDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "eff_state" : { "$ref" : "#/components/schemas/EmployeesEff_stateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EmployeesCreated_byResourceAttribute", "exampleSetFlag" : false }, "active_status" : { "$ref" : "#/components/schemas/EmployeesActive_statusResourceAttribute", "exampleSetFlag" : false }, "eff_supervisor" : { "$ref" : "#/components/schemas/EmployeesEff_supervisorResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/EmployeesDistrictResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_id" : { "$ref" : "#/components/schemas/EmployeesEff_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "eff_district_id" : { "$ref" : "#/components/schemas/EmployeesEff_district_idResourceAttribute", "exampleSetFlag" : false }, "position" : { "$ref" : "#/components/schemas/EmployeesPositionResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/EmployeesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "emp_type" : { "$ref" : "#/components/schemas/EmployeesEmp_typeResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/EmployeesRegionResourceAttribute", "exampleSetFlag" : false }, "eff_sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesEff_sup_emp_idResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/EmployeesSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "supervisor" : { "$ref" : "#/components/schemas/EmployeesSupervisorResourceAttribute", "exampleSetFlag" : false }, "eff_district" : { "$ref" : "#/components/schemas/EmployeesEff_districtResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/EmployeesEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesResourcePostRelationships", "exampleSetFlag" : false } ] }, "EmployeesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "reason" : { "$ref" : "#/components/schemas/EmployeesReasonResourceAttribute", "exampleSetFlag" : false }, "estimated_return_date" : { "$ref" : "#/components/schemas/EmployeesEstimated_return_dateResourceAttribute", "exampleSetFlag" : false }, "district_abbr" : { "$ref" : "#/components/schemas/EmployeesDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesSup_emp_idResourceAttribute", "exampleSetFlag" : false }, "exclusion_code" : { "$ref" : "#/components/schemas/EmployeesExclusion_codeResourceAttribute", "exampleSetFlag" : false }, "eff_district_abbr" : { "$ref" : "#/components/schemas/EmployeesEff_district_abbrResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EmployeesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_code" : { "$ref" : "#/components/schemas/EmployeesEff_sup_group_codeResourceAttribute", "exampleSetFlag" : false }, "legal_name_last" : { "$ref" : "#/components/schemas/EmployeesLegal_name_lastResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/EmployeesEffective_dateResourceAttribute", "exampleSetFlag" : false }, "action" : { "$ref" : "#/components/schemas/EmployeesActionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/EmployeesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "legal_name" : { "$ref" : "#/components/schemas/EmployeesLegal_nameResourceAttribute", "exampleSetFlag" : false }, "job_code" : { "$ref" : "#/components/schemas/EmployeesJob_codeResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/EmployeesStateResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/EmployeesEmailResourceAttribute", "exampleSetFlag" : false }, "eff_region" : { "$ref" : "#/components/schemas/EmployeesEff_regionResourceAttribute", "exampleSetFlag" : false }, "sup_group_id" : { "$ref" : "#/components/schemas/EmployeesSup_group_idResourceAttribute", "exampleSetFlag" : false }, "legal_name_first" : { "$ref" : "#/components/schemas/EmployeesLegal_name_firstResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/EmployeesDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "eff_state" : { "$ref" : "#/components/schemas/EmployeesEff_stateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EmployeesCreated_byResourceAttribute", "exampleSetFlag" : false }, "active_status" : { "$ref" : "#/components/schemas/EmployeesActive_statusResourceAttribute", "exampleSetFlag" : false }, "eff_supervisor" : { "$ref" : "#/components/schemas/EmployeesEff_supervisorResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/EmployeesCreated_onResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/EmployeesDistrictResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_id" : { "$ref" : "#/components/schemas/EmployeesEff_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "eff_district_id" : { "$ref" : "#/components/schemas/EmployeesEff_district_idResourceAttribute", "exampleSetFlag" : false }, "position" : { "$ref" : "#/components/schemas/EmployeesPositionResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/EmployeesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "emp_type" : { "$ref" : "#/components/schemas/EmployeesEmp_typeResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/EmployeesRegionResourceAttribute", "exampleSetFlag" : false }, "eff_sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesEff_sup_emp_idResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/EmployeesSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "supervisor" : { "$ref" : "#/components/schemas/EmployeesSupervisorResourceAttribute", "exampleSetFlag" : false }, "eff_district" : { "$ref" : "#/components/schemas/EmployeesEff_districtResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/EmployeesEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesSchedulerJobsInfoResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesWirelessInventoriesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesSupervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesDistrict_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "EmployeesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employees)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employees" ] }, "id" : { "$ref" : "#/components/schemas/EmployeesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employees/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesUserDataAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesInvestigationsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesEff_districtResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesCommentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesEff_district_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesResourceLinks", "exampleSetFlag" : false } ] }, "EmployeesEff_supervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesEff_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesSup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsEff_supervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsEff_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsEmailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsReasonResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsPositionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsSup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsEff_sup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsEff_sup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsLegal_name_firstResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsSupgroupResourceAttribute" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeesActiveMultipleItAssetsEff_regionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveMultipleItAssetsExclusion_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsEff_sup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "reason" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsReasonResourceAttribute", "exampleSetFlag" : false }, "estimated_return_date" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEstimated_return_dateResourceAttribute", "exampleSetFlag" : false }, "district_abbr" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsSup_emp_idResourceAttribute", "exampleSetFlag" : false }, "exclusion_code" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsExclusion_codeResourceAttribute", "exampleSetFlag" : false }, "eff_district_abbr" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEff_district_abbrResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_code" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEff_sup_group_codeResourceAttribute", "exampleSetFlag" : false }, "legal_name_last" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsLegal_name_lastResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEffective_dateResourceAttribute", "exampleSetFlag" : false }, "action" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsActionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "legal_name" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsLegal_nameResourceAttribute", "exampleSetFlag" : false }, "job_code" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsJob_codeResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsStateResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEmailResourceAttribute", "exampleSetFlag" : false }, "eff_region" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEff_regionResourceAttribute", "exampleSetFlag" : false }, "sup_group_id" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsSup_group_idResourceAttribute", "exampleSetFlag" : false }, "legal_name_first" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsLegal_name_firstResourceAttribute", "exampleSetFlag" : false }, "eff_state" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEff_stateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsCreated_byResourceAttribute", "exampleSetFlag" : false }, "active_status" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsActive_statusResourceAttribute", "exampleSetFlag" : false }, "eff_supervisor" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEff_supervisorResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsCreated_onResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsDistrictResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_id" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEff_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "eff_district_id" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEff_district_idResourceAttribute", "exampleSetFlag" : false }, "position" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsPositionResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "emp_type" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEmp_typeResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsRegionResourceAttribute", "exampleSetFlag" : false }, "eff_sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEff_sup_emp_idResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "supervisor" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsSupervisorResourceAttribute", "exampleSetFlag" : false }, "eff_district" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEff_districtResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveMultipleItAssetsRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsEff_districtResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "EmployeesActiveMultipleItAssetsEstimated_return_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeesActiveMultipleItAssetsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "EmployeesActiveMultipleItAssetsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeesActiveMultipleItAssetsEmp_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsSup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsAssetAssignmentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesActiveMultipleItAssetsActionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsEffective_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeesActiveMultipleItAssetsSupervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsActive_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsDistrict_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsLegal_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveMultipleItAssetsJob_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsVehiclesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesActiveMultipleItAssetsEff_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employeesActiveMultipleItAssets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employeesActiveMultipleItAssets" ] }, "id" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveMultipleItAssetsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveMultipleItAssetsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAssignments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/relationships/assetAssignments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/assetAssignments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/relationships/dist" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/dist" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "vehicles" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/relationships/vehicles" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/vehicles" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supgroup" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/relationships/supgroup" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveMultipleItAssets/{id}/supgroup" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveMultipleItAssetsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveMultipleItAssetsSup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsEff_district_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsLegal_name_lastResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeesActiveMultipleItAssetsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsDistResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeesActiveMultipleItAssetsDistrictResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveMultipleItAssetsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveMultipleItAssetsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveMultipleItAssetsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employeesActiveMultipleItAssets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employeesActiveMultipleItAssets" ] }, "id" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveMultipleItAssetsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceLinks", "exampleSetFlag" : false } ] }, "EmployeesActiveMultipleItAssetsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsPostResourceReference", "exampleSetFlag" : false } ] }, "EmployeesActiveMultipleItAssetsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveMultipleItAssets/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsEff_regionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsEff_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveNoAssets/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsSup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsEff_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsVehiclesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesActiveNoAssetsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsJob_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsLegal_name_firstResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsEmailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employeesActiveNoAssets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employeesActiveNoAssets" ] }, "id" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsEmp_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsEff_sup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsEff_districtResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsEffective_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeesActiveNoAssetsSup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsActive_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsEff_supervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsDistResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeesActiveNoAssetsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAssignments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveNoAssets/{id}/relationships/assetAssignments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveNoAssets/{id}/assetAssignments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveNoAssets/{id}/relationships/dist" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveNoAssets/{id}/dist" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "vehicles" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveNoAssets/{id}/relationships/vehicles" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveNoAssets/{id}/vehicles" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supgroup" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveNoAssets/{id}/relationships/supgroup" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesActiveNoAssets/{id}/supgroup" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsEff_sup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsAssetAssignmentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesActiveNoAssetsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employeesActiveNoAssets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employeesActiveNoAssets" ] }, "id" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsDistrict_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsSup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsPositionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceLinks", "exampleSetFlag" : false } ] }, "EmployeesActiveNoAssetsEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsEff_sup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_abbr" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsSup_emp_idResourceAttribute", "exampleSetFlag" : false }, "exclusion_code" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsExclusion_codeResourceAttribute", "exampleSetFlag" : false }, "eff_district_abbr" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEff_district_abbrResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_code" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEff_sup_group_codeResourceAttribute", "exampleSetFlag" : false }, "legal_name_last" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsLegal_name_lastResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEffective_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "legal_name" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsLegal_nameResourceAttribute", "exampleSetFlag" : false }, "job_code" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsJob_codeResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsStateResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEmailResourceAttribute", "exampleSetFlag" : false }, "eff_region" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEff_regionResourceAttribute", "exampleSetFlag" : false }, "sup_group_id" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsSup_group_idResourceAttribute", "exampleSetFlag" : false }, "legal_name_first" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsLegal_name_firstResourceAttribute", "exampleSetFlag" : false }, "eff_state" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEff_stateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsCreated_byResourceAttribute", "exampleSetFlag" : false }, "active_status" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsActive_statusResourceAttribute", "exampleSetFlag" : false }, "eff_supervisor" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEff_supervisorResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsCreated_onResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsDistrictResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_id" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEff_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "eff_district_id" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEff_district_idResourceAttribute", "exampleSetFlag" : false }, "position" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsPositionResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "emp_type" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEmp_typeResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsRegionResourceAttribute", "exampleSetFlag" : false }, "eff_sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEff_sup_emp_idResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "supervisor" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsSupervisorResourceAttribute", "exampleSetFlag" : false }, "eff_district" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEff_districtResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesActiveNoAssetsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "EmployeesActiveNoAssetsLegal_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsExclusion_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsSupervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsLegal_name_lastResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "EmployeesActiveNoAssetsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeesActiveNoAssetsSupgroupResourceAttribute" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeesActiveNoAssetsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsPostResourceReference", "exampleSetFlag" : false } ] }, "EmployeesActiveNoAssetsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesActiveNoAssetsDistrictResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeesActiveNoAssetsEff_district_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesActiveNoAssetsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanEff_sup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesOnLoanEffective_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EmployeesOnLoanEff_sup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesOnLoanDistResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeesOnLoanCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanWirelessInventoriesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesOnLoanSup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanEff_supervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesOnLoanPostResourceReference", "exampleSetFlag" : false } ] }, "EmployeesOnLoanPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanLegal_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanEff_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesOnLoanSup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesOnLoanPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employeesOnLoan)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employeesOnLoan" ] }, "id" : { "$ref" : "#/components/schemas/EmployeesOnLoanIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "EmployeesOnLoanSupgroupResourceAttribute" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EmployeesOnLoanCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeesOnLoanEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesOnLoanLegal_name_lastResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EmployeesOnLoanPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesOnLoanPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanSupervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanVehiclesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesOnLoanResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assetAssignments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/relationships/assetAssignments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/assetAssignments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "wirelessInventories" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/relationships/wirelessInventories" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/wirelessInventories" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/relationships/dist" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/dist" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "vehicles" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/relationships/vehicles" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/vehicles" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "supgroup" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/relationships/supgroup" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}/supgroup" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanPositionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanEmailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanEff_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (employeesOnLoan)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "employeesOnLoan" ] }, "id" : { "$ref" : "#/components/schemas/EmployeesOnLoanIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanDistrict_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanEff_regionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanDistrictResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanEmp_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceLinks", "exampleSetFlag" : false } ] }, "EmployeesOnLoanIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesOnLoanEff_district_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanLegal_name_firstResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanActive_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanAssetAssignmentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "EmployeesOnLoanJob_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesOnLoanRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "EmployeesOnLoanEff_sup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/employeesOnLoan/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanExclusion_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesOnLoanResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_abbr" : { "$ref" : "#/components/schemas/EmployeesOnLoanDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesOnLoanSup_emp_idResourceAttribute", "exampleSetFlag" : false }, "exclusion_code" : { "$ref" : "#/components/schemas/EmployeesOnLoanExclusion_codeResourceAttribute", "exampleSetFlag" : false }, "eff_district_abbr" : { "$ref" : "#/components/schemas/EmployeesOnLoanEff_district_abbrResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EmployeesOnLoanLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_code" : { "$ref" : "#/components/schemas/EmployeesOnLoanEff_sup_group_codeResourceAttribute", "exampleSetFlag" : false }, "legal_name_last" : { "$ref" : "#/components/schemas/EmployeesOnLoanLegal_name_lastResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/EmployeesOnLoanEffective_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/EmployeesOnLoanLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "legal_name" : { "$ref" : "#/components/schemas/EmployeesOnLoanLegal_nameResourceAttribute", "exampleSetFlag" : false }, "job_code" : { "$ref" : "#/components/schemas/EmployeesOnLoanJob_codeResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/EmployeesOnLoanStateResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/EmployeesOnLoanEmailResourceAttribute", "exampleSetFlag" : false }, "eff_region" : { "$ref" : "#/components/schemas/EmployeesOnLoanEff_regionResourceAttribute", "exampleSetFlag" : false }, "sup_group_id" : { "$ref" : "#/components/schemas/EmployeesOnLoanSup_group_idResourceAttribute", "exampleSetFlag" : false }, "legal_name_first" : { "$ref" : "#/components/schemas/EmployeesOnLoanLegal_name_firstResourceAttribute", "exampleSetFlag" : false }, "eff_state" : { "$ref" : "#/components/schemas/EmployeesOnLoanEff_stateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EmployeesOnLoanCreated_byResourceAttribute", "exampleSetFlag" : false }, "active_status" : { "$ref" : "#/components/schemas/EmployeesOnLoanActive_statusResourceAttribute", "exampleSetFlag" : false }, "eff_supervisor" : { "$ref" : "#/components/schemas/EmployeesOnLoanEff_supervisorResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/EmployeesOnLoanCreated_onResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/EmployeesOnLoanDistrictResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_id" : { "$ref" : "#/components/schemas/EmployeesOnLoanEff_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "eff_district_id" : { "$ref" : "#/components/schemas/EmployeesOnLoanEff_district_idResourceAttribute", "exampleSetFlag" : false }, "position" : { "$ref" : "#/components/schemas/EmployeesOnLoanPositionResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/EmployeesOnLoanDistrict_idResourceAttribute", "exampleSetFlag" : false }, "emp_type" : { "$ref" : "#/components/schemas/EmployeesOnLoanEmp_typeResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/EmployeesOnLoanRegionResourceAttribute", "exampleSetFlag" : false }, "eff_sup_emp_id" : { "$ref" : "#/components/schemas/EmployeesOnLoanEff_sup_emp_idResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/EmployeesOnLoanSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "supervisor" : { "$ref" : "#/components/schemas/EmployeesOnLoanSupervisorResourceAttribute", "exampleSetFlag" : false }, "eff_district" : { "$ref" : "#/components/schemas/EmployeesOnLoanEff_districtResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/EmployeesOnLoanEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EmployeesOnLoanEff_districtResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EmployeesOnLoanDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EmployeesOnLoanSup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ErrorLogsError_stateResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ErrorLogsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (errorLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "errorLogs" ] }, "id" : { "$ref" : "#/components/schemas/ErrorLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "severity" : { "$ref" : "#/components/schemas/ErrorLogsSeverityResourceAttribute", "exampleSetFlag" : false }, "error_state" : { "$ref" : "#/components/schemas/ErrorLogsError_stateResourceAttribute", "exampleSetFlag" : false }, "module" : { "$ref" : "#/components/schemas/ErrorLogsModuleResourceAttribute", "exampleSetFlag" : false }, "line_no" : { "$ref" : "#/components/schemas/ErrorLogsLine_noResourceAttribute", "exampleSetFlag" : false }, "creation_date" : { "$ref" : "#/components/schemas/ErrorLogsCreation_dateResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/ErrorLogsMessageResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ErrorLogsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (errorLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "errorLogs" ] }, "id" : { "$ref" : "#/components/schemas/ErrorLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ErrorLogsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ErrorLogsResourcePostAttributes", "exampleSetFlag" : false } ] }, "ErrorLogsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ErrorLogsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ErrorLogsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ErrorLogsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/errorLogs/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ErrorLogsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ErrorLogsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ErrorLogsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ErrorLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsSeverityResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ErrorLogsLine_noResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ErrorLogsMessageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ErrorLogsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "severity" : { "$ref" : "#/components/schemas/ErrorLogsSeverityResourceAttribute", "exampleSetFlag" : false }, "error_state" : { "$ref" : "#/components/schemas/ErrorLogsError_stateResourceAttribute", "exampleSetFlag" : false }, "module" : { "$ref" : "#/components/schemas/ErrorLogsModuleResourceAttribute", "exampleSetFlag" : false }, "line_no" : { "$ref" : "#/components/schemas/ErrorLogsLine_noResourceAttribute", "exampleSetFlag" : false }, "creation_date" : { "$ref" : "#/components/schemas/ErrorLogsCreation_dateResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/ErrorLogsMessageResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsCreation_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ErrorLogsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ErrorLogsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ErrorLogsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ErrorLogsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ErrorLogsModuleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ErrorLogsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ErrorLogsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ErrorLogsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ErrorLogsResourceLinks", "exampleSetFlag" : false } ] }, "ErrorLogsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "severity" : { "$ref" : "#/components/schemas/ErrorLogsSeverityResourceAttribute", "exampleSetFlag" : false }, "error_state" : { "$ref" : "#/components/schemas/ErrorLogsError_stateResourceAttribute", "exampleSetFlag" : false }, "module" : { "$ref" : "#/components/schemas/ErrorLogsModuleResourceAttribute", "exampleSetFlag" : false }, "line_no" : { "$ref" : "#/components/schemas/ErrorLogsLine_noResourceAttribute", "exampleSetFlag" : false }, "creation_date" : { "$ref" : "#/components/schemas/ErrorLogsCreation_dateResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/ErrorLogsMessageResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesInvestigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesCompletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "EstimatesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesEstimate_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EstimatesWf_notification_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesPolicy_drop_offResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "EstimatesEstimate_category_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "financialPeriod" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/relationships/financialPeriod" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/financialPeriod" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsInvestigationDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/relationships/cmsInvestigationDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/cmsInvestigationDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "district" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/relationships/district" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/district" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "quickCValue" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/relationships/quickCValue" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/quickCValue" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsRequest" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/relationships/cmsRequest" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}/cmsRequest" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "dispute_reason_id" : { "$ref" : "#/components/schemas/EstimatesDispute_reason_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/EstimatesInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "estimate_category_id" : { "$ref" : "#/components/schemas/EstimatesEstimate_category_idResourceAttribute", "exampleSetFlag" : false }, "difference_reason_id" : { "$ref" : "#/components/schemas/EstimatesDifference_reason_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/EstimatesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "dispute_estimate" : { "$ref" : "#/components/schemas/EstimatesDispute_estimateResourceAttribute", "exampleSetFlag" : false }, "accrual_amount" : { "$ref" : "#/components/schemas/EstimatesAccrual_amountResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/EstimatesCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "change_reason" : { "$ref" : "#/components/schemas/EstimatesChange_reasonResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_month" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_monthResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EstimatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "adjusted_amount" : { "$ref" : "#/components/schemas/EstimatesAdjusted_amountResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_ratio" : { "$ref" : "#/components/schemas/EstimatesCount_against_quality_ratioResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_offResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/EstimatesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "wf_notification_id" : { "$ref" : "#/components/schemas/EstimatesWf_notification_idResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_amount" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_amountResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/EstimatesPeriod_idResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/EstimatesCompleted_byResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/EstimatesDamage_idResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/EstimatesApproverResourceAttribute", "exampleSetFlag" : false }, "amount" : { "$ref" : "#/components/schemas/EstimatesAmountResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/EstimatesActiveResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/EstimatesCompletedResourceAttribute", "exampleSetFlag" : false }, "prorated_payment_amount" : { "$ref" : "#/components/schemas/EstimatesProrated_payment_amountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EstimatesCreated_byResourceAttribute", "exampleSetFlag" : false }, "estimate_date" : { "$ref" : "#/components/schemas/EstimatesEstimate_dateResourceAttribute", "exampleSetFlag" : false }, "default_amount" : { "$ref" : "#/components/schemas/EstimatesDefault_amountResourceAttribute", "exampleSetFlag" : false }, "accrual_balance" : { "$ref" : "#/components/schemas/EstimatesAccrual_balanceResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/EstimatesInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/EstimatesAccruedResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_period_id" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_period_idResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/EstimatesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_year" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_yearResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/EstimatesAttributes3ResourceAttribute", "exampleSetFlag" : false }, "third_party_name" : { "$ref" : "#/components/schemas/EstimatesThird_party_nameResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/EstimatesAttributes2ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/EstimatesRequest_idResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/EstimatesAttributes1ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesQuickCValueResourceAttribute" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EstimatesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/EstimatesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesPolicy_drop_off_period_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "dispute_reason_id" : { "$ref" : "#/components/schemas/EstimatesDispute_reason_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/EstimatesInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/EstimatesVersion_numberResourceAttribute", "exampleSetFlag" : false }, "estimate_category_id" : { "$ref" : "#/components/schemas/EstimatesEstimate_category_idResourceAttribute", "exampleSetFlag" : false }, "difference_reason_id" : { "$ref" : "#/components/schemas/EstimatesDifference_reason_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/EstimatesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "dispute_estimate" : { "$ref" : "#/components/schemas/EstimatesDispute_estimateResourceAttribute", "exampleSetFlag" : false }, "accrual_amount" : { "$ref" : "#/components/schemas/EstimatesAccrual_amountResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/EstimatesCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "change_reason" : { "$ref" : "#/components/schemas/EstimatesChange_reasonResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_month" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_monthResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EstimatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "adjusted_amount" : { "$ref" : "#/components/schemas/EstimatesAdjusted_amountResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_ratio" : { "$ref" : "#/components/schemas/EstimatesCount_against_quality_ratioResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_offResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/EstimatesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "wf_notification_id" : { "$ref" : "#/components/schemas/EstimatesWf_notification_idResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_amount" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_amountResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/EstimatesPeriod_idResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/EstimatesCompleted_byResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/EstimatesDamage_idResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/EstimatesApproverResourceAttribute", "exampleSetFlag" : false }, "amount" : { "$ref" : "#/components/schemas/EstimatesAmountResourceAttribute", "exampleSetFlag" : false }, "estimate_id" : { "$ref" : "#/components/schemas/EstimatesEstimate_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/EstimatesActiveResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/EstimatesCompletedResourceAttribute", "exampleSetFlag" : false }, "prorated_payment_amount" : { "$ref" : "#/components/schemas/EstimatesProrated_payment_amountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EstimatesCreated_byResourceAttribute", "exampleSetFlag" : false }, "estimate_date" : { "$ref" : "#/components/schemas/EstimatesEstimate_dateResourceAttribute", "exampleSetFlag" : false }, "default_amount" : { "$ref" : "#/components/schemas/EstimatesDefault_amountResourceAttribute", "exampleSetFlag" : false }, "accrual_balance" : { "$ref" : "#/components/schemas/EstimatesAccrual_balanceResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/EstimatesCreated_onResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/EstimatesInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/EstimatesAccruedResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_period_id" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_period_idResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/EstimatesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_year" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_yearResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/EstimatesAttributes3ResourceAttribute", "exampleSetFlag" : false }, "third_party_name" : { "$ref" : "#/components/schemas/EstimatesThird_party_nameResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/EstimatesAttributes2ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/EstimatesRequest_idResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/EstimatesAttributes1ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesAccrual_balanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "EstimatesAdjusted_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "EstimatesInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EstimatesIdResourceAttribute" : { "type" : "object", "properties" : { "estimate_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "version_number" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesAttributes1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EstimatesAccrual_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "EstimatesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (estimates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "estimates" ] }, "id" : { "$ref" : "#/components/schemas/EstimatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesDifference_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EstimatesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EstimatesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EstimatesResourceLinks", "exampleSetFlag" : false } ] }, "EstimatesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "dispute_reason_id" : { "$ref" : "#/components/schemas/EstimatesDispute_reason_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/EstimatesInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "estimate_category_id" : { "$ref" : "#/components/schemas/EstimatesEstimate_category_idResourceAttribute", "exampleSetFlag" : false }, "difference_reason_id" : { "$ref" : "#/components/schemas/EstimatesDifference_reason_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/EstimatesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "dispute_estimate" : { "$ref" : "#/components/schemas/EstimatesDispute_estimateResourceAttribute", "exampleSetFlag" : false }, "accrual_amount" : { "$ref" : "#/components/schemas/EstimatesAccrual_amountResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/EstimatesCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "change_reason" : { "$ref" : "#/components/schemas/EstimatesChange_reasonResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_month" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_monthResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/EstimatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "adjusted_amount" : { "$ref" : "#/components/schemas/EstimatesAdjusted_amountResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_ratio" : { "$ref" : "#/components/schemas/EstimatesCount_against_quality_ratioResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_offResourceAttribute", "exampleSetFlag" : false }, "wf_notification_id" : { "$ref" : "#/components/schemas/EstimatesWf_notification_idResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_amount" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_amountResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/EstimatesPeriod_idResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/EstimatesCompleted_byResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/EstimatesDamage_idResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/EstimatesApproverResourceAttribute", "exampleSetFlag" : false }, "amount" : { "$ref" : "#/components/schemas/EstimatesAmountResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/EstimatesActiveResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/EstimatesCompletedResourceAttribute", "exampleSetFlag" : false }, "prorated_payment_amount" : { "$ref" : "#/components/schemas/EstimatesProrated_payment_amountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/EstimatesCreated_byResourceAttribute", "exampleSetFlag" : false }, "estimate_date" : { "$ref" : "#/components/schemas/EstimatesEstimate_dateResourceAttribute", "exampleSetFlag" : false }, "default_amount" : { "$ref" : "#/components/schemas/EstimatesDefault_amountResourceAttribute", "exampleSetFlag" : false }, "accrual_balance" : { "$ref" : "#/components/schemas/EstimatesAccrual_balanceResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/EstimatesInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/EstimatesAccruedResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_period_id" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_period_idResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/EstimatesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_year" : { "$ref" : "#/components/schemas/EstimatesPolicy_drop_off_yearResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/EstimatesAttributes3ResourceAttribute", "exampleSetFlag" : false }, "third_party_name" : { "$ref" : "#/components/schemas/EstimatesThird_party_nameResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/EstimatesAttributes2ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/EstimatesRequest_idResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/EstimatesAttributes1ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesDamage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesPolicy_drop_off_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "EstimatesEstimate_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EstimatesFinancialPeriodResourceAttribute" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EstimatesPeriod_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesAttributes3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EstimatesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EstimatesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EstimatesResourcePostAttributes", "exampleSetFlag" : false } ] }, "EstimatesDistrictResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EstimatesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (estimates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "estimates" ] }, "id" : { "$ref" : "#/components/schemas/EstimatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesProrated_payment_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "EstimatesPolicy_drop_off_monthResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EstimatesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "EstimatesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/estimates/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesDispute_estimateResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "EstimatesCmsInvestigationDetailResourceAttribute" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EstimatesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/EstimatesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "EstimatesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "EstimatesCompleted_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesDefault_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "EstimatesRequest_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "EstimatesCmsRequestResourceAttribute" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "EstimatesChange_reasonResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EstimatesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "EstimatesWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesApproverResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesAttributes2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EstimatesVersion_numberResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesCount_against_quality_ratioResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "EstimatesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/EstimatesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "EstimatesDispute_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesPolicy_drop_off_yearResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EstimatesAmountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "EstimatesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesThird_party_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "EstimatesInvestigation_detail_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "EstimatesAccruedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ExcavatorResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ExcavatorResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ExcavatorResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ExcavatorResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ExcavatorNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ExcavatorIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ExcavatorResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "contact_name" : { "$ref" : "#/components/schemas/ExcavatorContact_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ExcavatorLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contact_phone_number" : { "$ref" : "#/components/schemas/ExcavatorContact_phone_numberResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ExcavatorCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ExcavatorNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ExcavatorLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ExcavatorCreated_byResourceAttribute", "exampleSetFlag" : false }, "contact_email" : { "$ref" : "#/components/schemas/ExcavatorContact_emailResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "contact_name" : { "$ref" : "#/components/schemas/ExcavatorContact_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ExcavatorLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contact_phone_number" : { "$ref" : "#/components/schemas/ExcavatorContact_phone_numberResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ExcavatorNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ExcavatorLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ExcavatorCreated_byResourceAttribute", "exampleSetFlag" : false }, "contact_email" : { "$ref" : "#/components/schemas/ExcavatorContact_emailResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ExcavatorResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ExcavatorInvestigationsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ExcavatorPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ExcavatorPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorContact_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ExcavatorCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ExcavatorResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ExcavatorResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ExcavatorResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ExcavatorResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ExcavatorResourceLinks", "exampleSetFlag" : false } ] }, "ExcavatorPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ExcavatorPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ExcavatorResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "contact_name" : { "$ref" : "#/components/schemas/ExcavatorContact_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ExcavatorLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "contact_phone_number" : { "$ref" : "#/components/schemas/ExcavatorContact_phone_numberResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ExcavatorNameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ExcavatorCreated_byResourceAttribute", "exampleSetFlag" : false }, "contact_email" : { "$ref" : "#/components/schemas/ExcavatorContact_emailResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorContact_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ExcavatorResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/excavator/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ExcavatorResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ExcavatorResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (excavator)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "excavator" ] }, "id" : { "$ref" : "#/components/schemas/ExcavatorIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ExcavatorPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ExcavatorResourcePostAttributes", "exampleSetFlag" : false } ] }, "ExcavatorResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (excavator)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "excavator" ] }, "id" : { "$ref" : "#/components/schemas/ExcavatorIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorContact_phone_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ExcavatorResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "investigations" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/excavator/{id}/relationships/investigations" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/excavator/{id}/investigations" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ExcavatorLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ExcavatorResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ExcavatorResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesBillableCustomersResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FacilitiesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/facilities/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FacilitiesPostResourceReference", "exampleSetFlag" : false } ] }, "FacilitiesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FacilitiesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FacilitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/FacilitiesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "FacilitiesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (facilities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "facilities" ] }, "id" : { "$ref" : "#/components/schemas/FacilitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesFd_investigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FacilitiesInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "FacilitiesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FacilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (facilities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "facilities" ] }, "id" : { "$ref" : "#/components/schemas/FacilitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesFd_damage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FacilitiesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FacilitiesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/FacilitiesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/FacilitiesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FacilitiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FacilitiesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FacilitiesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FacilitiesResourceLinks", "exampleSetFlag" : false } ] }, "FacilitiesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FacilitiesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "FacilitiesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "fd_investigation_id" : { "$ref" : "#/components/schemas/FacilitiesFd_investigation_idResourceAttribute", "exampleSetFlag" : false }, "fd_customer_name" : { "$ref" : "#/components/schemas/FacilitiesFd_customer_nameResourceAttribute", "exampleSetFlag" : false }, "fd_damage_id" : { "$ref" : "#/components/schemas/FacilitiesFd_damage_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "flatRateCustomers" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/facilities/{id}/relationships/flatRateCustomers" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/facilities/{id}/flatRateCustomers" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/facilities/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/facilities/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/facilities/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/facilities/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "billableCustomers" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/facilities/{id}/relationships/billableCustomers" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/facilities/{id}/billableCustomers" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BillableCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "FacilitiesDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "FacilitiesFlatRateCustomersResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FacilitiesFd_customer_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FeedsAllow_combineResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsResponseLogsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FeedsInactiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsNotify_excavatorsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsRespond_transResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FeedsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FeedsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FeedsResourceLinks", "exampleSetFlag" : false } ] }, "FeedsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FeedsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FeedsFeednameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FeedsReopen_on_updateResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsUpdate_due_datesResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsParser_onResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsUnique_transmissionsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsExtensionsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FeedsPreferredResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/FeedsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "respond_assignments" : { "$ref" : "#/components/schemas/FeedsRespond_assignmentsResourceAttribute", "exampleSetFlag" : false }, "low_volume_threshold" : { "$ref" : "#/components/schemas/FeedsLow_volume_thresholdResourceAttribute", "exampleSetFlag" : false }, "do_not_respond" : { "$ref" : "#/components/schemas/FeedsDo_not_respondResourceAttribute", "exampleSetFlag" : false }, "notify_reschedule" : { "$ref" : "#/components/schemas/FeedsNotify_rescheduleResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/FeedsDescriptionResourceAttribute", "exampleSetFlag" : false }, "respond_excav_notif" : { "$ref" : "#/components/schemas/FeedsRespond_excav_notifResourceAttribute", "exampleSetFlag" : false }, "manual" : { "$ref" : "#/components/schemas/FeedsManualResourceAttribute", "exampleSetFlag" : false }, "re_call_after_hours" : { "$ref" : "#/components/schemas/FeedsRe_call_after_hoursResourceAttribute", "exampleSetFlag" : false }, "respect_state_boundaries" : { "$ref" : "#/components/schemas/FeedsRespect_state_boundariesResourceAttribute", "exampleSetFlag" : false }, "respond_attachments" : { "$ref" : "#/components/schemas/FeedsRespond_attachmentsResourceAttribute", "exampleSetFlag" : false }, "update_callout_policy" : { "$ref" : "#/components/schemas/FeedsUpdate_callout_policyResourceAttribute", "exampleSetFlag" : false }, "inactive" : { "$ref" : "#/components/schemas/FeedsInactiveResourceAttribute", "exampleSetFlag" : false }, "sqlserverized_routing" : { "$ref" : "#/components/schemas/FeedsSqlserverized_routingResourceAttribute", "exampleSetFlag" : false }, "excav_notif_format" : { "$ref" : "#/components/schemas/FeedsExcav_notif_formatResourceAttribute", "exampleSetFlag" : false }, "delay_minutes" : { "$ref" : "#/components/schemas/FeedsDelay_minutesResourceAttribute", "exampleSetFlag" : false }, "reopen_on_update" : { "$ref" : "#/components/schemas/FeedsReopen_on_updateResourceAttribute", "exampleSetFlag" : false }, "re_call_normal_hours" : { "$ref" : "#/components/schemas/FeedsRe_call_normal_hoursResourceAttribute", "exampleSetFlag" : false }, "notify_excavators" : { "$ref" : "#/components/schemas/FeedsNotify_excavatorsResourceAttribute", "exampleSetFlag" : false }, "preferred" : { "$ref" : "#/components/schemas/FeedsPreferredResourceAttribute", "exampleSetFlag" : false }, "feed_state" : { "$ref" : "#/components/schemas/FeedsFeed_stateResourceAttribute", "exampleSetFlag" : false }, "unlocatable" : { "$ref" : "#/components/schemas/FeedsUnlocatableResourceAttribute", "exampleSetFlag" : false }, "billed_manually" : { "$ref" : "#/components/schemas/FeedsBilled_manuallyResourceAttribute", "exampleSetFlag" : false }, "allow_combine" : { "$ref" : "#/components/schemas/FeedsAllow_combineResourceAttribute", "exampleSetFlag" : false }, "respond_trans" : { "$ref" : "#/components/schemas/FeedsRespond_transResourceAttribute", "exampleSetFlag" : false }, "queue_responses" : { "$ref" : "#/components/schemas/FeedsQueue_responsesResourceAttribute", "exampleSetFlag" : false }, "unique_transmissions" : { "$ref" : "#/components/schemas/FeedsUnique_transmissionsResourceAttribute", "exampleSetFlag" : false }, "notif_pattern_id" : { "$ref" : "#/components/schemas/FeedsNotif_pattern_idResourceAttribute", "exampleSetFlag" : false }, "time_zone" : { "$ref" : "#/components/schemas/FeedsTime_zoneResourceAttribute", "exampleSetFlag" : false }, "excavator_reschedule" : { "$ref" : "#/components/schemas/FeedsExcavator_rescheduleResourceAttribute", "exampleSetFlag" : false }, "attach_transmission" : { "$ref" : "#/components/schemas/FeedsAttach_transmissionResourceAttribute", "exampleSetFlag" : false }, "one_call_center" : { "$ref" : "#/components/schemas/FeedsOne_call_centerResourceAttribute", "exampleSetFlag" : false }, "call_after_hours" : { "$ref" : "#/components/schemas/FeedsCall_after_hoursResourceAttribute", "exampleSetFlag" : false }, "sticky_routing" : { "$ref" : "#/components/schemas/FeedsSticky_routingResourceAttribute", "exampleSetFlag" : false }, "parser_id" : { "$ref" : "#/components/schemas/FeedsParser_idResourceAttribute", "exampleSetFlag" : false }, "feedname" : { "$ref" : "#/components/schemas/FeedsFeednameResourceAttribute", "exampleSetFlag" : false }, "extensions" : { "$ref" : "#/components/schemas/FeedsExtensionsResourceAttribute", "exampleSetFlag" : false }, "call_normal_hours" : { "$ref" : "#/components/schemas/FeedsCall_normal_hoursResourceAttribute", "exampleSetFlag" : false }, "re_call_events" : { "$ref" : "#/components/schemas/FeedsRe_call_eventsResourceAttribute", "exampleSetFlag" : false }, "parser_on" : { "$ref" : "#/components/schemas/FeedsParser_onResourceAttribute", "exampleSetFlag" : false }, "update_due_dates" : { "$ref" : "#/components/schemas/FeedsUpdate_due_datesResourceAttribute", "exampleSetFlag" : false }, "route_corporate_holidays" : { "$ref" : "#/components/schemas/FeedsRoute_corporate_holidaysResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsParser_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FeedsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (feeds)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "feeds" ] }, "id" : { "$ref" : "#/components/schemas/FeedsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsNotif_pattern_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FeedsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (feeds)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "feeds" ] }, "id" : { "$ref" : "#/components/schemas/FeedsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FeedsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "FeedsRespond_attachmentsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsDelay_minutesResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FeedsFeed_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FeedsUpdate_callout_policyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FeedsTermsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FeedsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "terms" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/feeds/{id}/relationships/terms" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/feeds/{id}/terms" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "responseLogs" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/feeds/{id}/relationships/responseLogs" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/feeds/{id}/responseLogs" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionsBase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/feeds/{id}/relationships/transmissionsBase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/feeds/{id}/transmissionsBase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/feeds/{id}/relationships/transmissions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/feeds/{id}/transmissions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsSqlserverized_routingResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsSticky_routingResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsTransmissionsBaseResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FeedsTime_zoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FeedsNotify_rescheduleResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsAttach_transmissionResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsQueue_responsesResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/FeedsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "FeedsLow_volume_thresholdResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FeedsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsExcavator_rescheduleResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsCall_normal_hoursResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsOne_call_centerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FeedsExcav_notif_formatResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FeedsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsRespect_state_boundariesResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/feeds/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsRe_call_normal_hoursResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsRespond_excav_notifResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FeedsPostResourceReference", "exampleSetFlag" : false } ] }, "FeedsRoute_corporate_holidaysResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsBilled_manuallyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsManualResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsUnlocatableResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsDo_not_respondResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsCall_after_hoursResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsTransmissionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FeedsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FeedsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FeedsRespond_assignmentsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsRe_call_after_hoursResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FeedsRe_call_eventsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FinancialPeriodsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FinancialPeriodsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FinancialPeriodsLegalRisksResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FinancialPeriodsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FinancialPeriodsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FinancialPeriodsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FinancialPeriodsResourcePostAttributes", "exampleSetFlag" : false } ] }, "FinancialPeriodsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (financialPeriods)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "financialPeriods" ] }, "id" : { "$ref" : "#/components/schemas/FinancialPeriodsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/FinancialPeriodsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/FinancialPeriodsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/FinancialPeriodsStatus_idResourceAttribute", "exampleSetFlag" : false }, "year" : { "$ref" : "#/components/schemas/FinancialPeriodsYearResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/FinancialPeriodsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "period_name" : { "$ref" : "#/components/schemas/FinancialPeriodsPeriod_nameResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/FinancialPeriodsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/FinancialPeriodsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/FinancialPeriodsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/FinancialPeriodsCreated_byResourceAttribute", "exampleSetFlag" : false }, "closed_for_estimates" : { "$ref" : "#/components/schemas/FinancialPeriodsClosed_for_estimatesResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/FinancialPeriodsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsClosed_for_estimatesResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FinancialPeriodsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsYearResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FinancialPeriodsPeriod_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FinancialPeriodsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "FinancialPeriodsClaimsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FinancialPeriodsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FinancialPeriodsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FinancialPeriodsEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FinancialPeriodsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/FinancialPeriodsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "year" : { "$ref" : "#/components/schemas/FinancialPeriodsYearResourceAttribute", "exampleSetFlag" : false }, "period_name" : { "$ref" : "#/components/schemas/FinancialPeriodsPeriod_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/FinancialPeriodsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/FinancialPeriodsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/FinancialPeriodsStatus_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/FinancialPeriodsCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/FinancialPeriodsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/FinancialPeriodsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/FinancialPeriodsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/FinancialPeriodsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "closed_for_estimates" : { "$ref" : "#/components/schemas/FinancialPeriodsClosed_for_estimatesResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/FinancialPeriodsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsStatus_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FinancialPeriodsAccrualsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FinancialPeriodsAccrualSummariesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FinancialPeriodsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "FinancialPeriodsPolicyDropOffEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "FinancialPeriodsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (financialPeriods)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "financialPeriods" ] }, "id" : { "$ref" : "#/components/schemas/FinancialPeriodsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FinancialPeriodsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FinancialPeriodsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FinancialPeriodsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FinancialPeriodsResourceLinks", "exampleSetFlag" : false } ] }, "FinancialPeriodsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/FinancialPeriodsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/FinancialPeriodsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/FinancialPeriodsStatus_idResourceAttribute", "exampleSetFlag" : false }, "year" : { "$ref" : "#/components/schemas/FinancialPeriodsYearResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/FinancialPeriodsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "period_name" : { "$ref" : "#/components/schemas/FinancialPeriodsPeriod_nameResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/FinancialPeriodsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/FinancialPeriodsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/FinancialPeriodsCreated_byResourceAttribute", "exampleSetFlag" : false }, "closed_for_estimates" : { "$ref" : "#/components/schemas/FinancialPeriodsClosed_for_estimatesResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/FinancialPeriodsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "policyDropOffEstimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/relationships/policyDropOffEstimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/policyDropOffEstimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "accruals" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/relationships/accruals" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/accruals" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claims" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/relationships/claims" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/claims" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalRisks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/relationships/legalRisks" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/legalRisks" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "accrualSummaries" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/relationships/accrualSummaries" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/accrualSummaries" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "estimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/relationships/estimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}/estimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "FinancialPeriodsEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "FinancialPeriodsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FinancialPeriodsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/FinancialPeriodsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "FinancialPeriodsStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "FinancialPeriodsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/financialPeriods/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "FinancialPeriodsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FlatRateCustomersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "cmsCustomer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/flatRateCustomers/{id}/relationships/cmsCustomer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/flatRateCustomers/{id}/cmsCustomer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "state" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/flatRateCustomers/{id}/relationships/state" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/flatRateCustomers/{id}/state" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "facility" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/flatRateCustomers/{id}/relationships/facility" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/flatRateCustomers/{id}/facility" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FacilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FacilitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FlatRateCustomersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "FlatRateCustomersUtility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FlatRateCustomersActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FlatRateCustomersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FlatRateCustomersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FlatRateCustomersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FlatRateCustomersResourceLinks", "exampleSetFlag" : false } ] }, "FlatRateCustomersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FlatRateCustomersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/FlatRateCustomersEnd_dateResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/FlatRateCustomersActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/FlatRateCustomersCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/FlatRateCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/FlatRateCustomersUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/FlatRateCustomersFacility_idResourceAttribute", "exampleSetFlag" : false }, "state_id" : { "$ref" : "#/components/schemas/FlatRateCustomersState_idResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_guarantee" : { "$ref" : "#/components/schemas/FlatRateCustomersCount_against_quality_guaranteeResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/FlatRateCustomersCustomer_idResourceAttribute", "exampleSetFlag" : false }, "auto_approve_claims" : { "$ref" : "#/components/schemas/FlatRateCustomersAuto_approve_claimsResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/FlatRateCustomersFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "approval_limit" : { "$ref" : "#/components/schemas/FlatRateCustomersApproval_limitResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/FlatRateCustomersStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "FlatRateCustomersEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "FlatRateCustomersAuto_approve_claimsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FlatRateCustomersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (flatRateCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "flatRateCustomers" ] }, "id" : { "$ref" : "#/components/schemas/FlatRateCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersApproval_limitResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "FlatRateCustomersCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FlatRateCustomersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FlatRateCustomersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FlatRateCustomersResourcePostAttributes", "exampleSetFlag" : false } ] }, "FlatRateCustomersCmsCustomerResourceAttribute" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "FlatRateCustomersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (flatRateCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "flatRateCustomers" ] }, "id" : { "$ref" : "#/components/schemas/FlatRateCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/FlatRateCustomersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "FlatRateCustomersCount_against_quality_guaranteeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "FlatRateCustomersStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "FlatRateCustomersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/flatRateCustomers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "FlatRateCustomersStateResourceAttribute" : { "$ref" : "#/components/schemas/StatesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "FlatRateCustomersCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FlatRateCustomersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/FlatRateCustomersEnd_dateResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/FlatRateCustomersActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/FlatRateCustomersCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/FlatRateCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/FlatRateCustomersUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/FlatRateCustomersCreated_onResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/FlatRateCustomersFacility_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/FlatRateCustomersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state_id" : { "$ref" : "#/components/schemas/FlatRateCustomersState_idResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_guarantee" : { "$ref" : "#/components/schemas/FlatRateCustomersCount_against_quality_guaranteeResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/FlatRateCustomersCustomer_idResourceAttribute", "exampleSetFlag" : false }, "auto_approve_claims" : { "$ref" : "#/components/schemas/FlatRateCustomersAuto_approve_claimsResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/FlatRateCustomersFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "approval_limit" : { "$ref" : "#/components/schemas/FlatRateCustomersApproval_limitResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/FlatRateCustomersStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersFacility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FlatRateCustomersState_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "FlatRateCustomersFacilityResourceAttribute" : { "$ref" : "#/components/schemas/FacilitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "FlatRateCustomersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/FlatRateCustomersResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "FlatRateCustomersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/FlatRateCustomersEnd_dateResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/FlatRateCustomersActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/FlatRateCustomersCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/FlatRateCustomersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/FlatRateCustomersUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/FlatRateCustomersFacility_idResourceAttribute", "exampleSetFlag" : false }, "state_id" : { "$ref" : "#/components/schemas/FlatRateCustomersState_idResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_guarantee" : { "$ref" : "#/components/schemas/FlatRateCustomersCount_against_quality_guaranteeResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/FlatRateCustomersCustomer_idResourceAttribute", "exampleSetFlag" : false }, "auto_approve_claims" : { "$ref" : "#/components/schemas/FlatRateCustomersAuto_approve_claimsResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/FlatRateCustomersFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "approval_limit" : { "$ref" : "#/components/schemas/FlatRateCustomersApproval_limitResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/FlatRateCustomersStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "FlatRateCustomersFacility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "IdeaKindsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "IdeaKindsSort_orderResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "IdeaKindsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "IdeaKindsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/IdeaKindsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/IdeaKindsNameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/IdeaKindsActiveResourceAttribute", "exampleSetFlag" : false }, "sort_order" : { "$ref" : "#/components/schemas/IdeaKindsSort_orderResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/IdeaKindsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ideaKinds)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ideaKinds" ] }, "id" : { "$ref" : "#/components/schemas/IdeaKindsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/IdeaKindsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/IdeaKindsResourcePostAttributes", "exampleSetFlag" : false } ] }, "IdeaKindsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/IdeaKindsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "IdeaKindsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "IdeaKindsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideaKinds/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeaKindsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "IdeaKindsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ideaKinds)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ideaKinds" ] }, "id" : { "$ref" : "#/components/schemas/IdeaKindsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeaKindsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "IdeaKindsActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "IdeaKindsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/IdeaKindsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "IdeaKindsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeaKindsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "IdeaKindsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/IdeaKindsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/IdeaKindsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/IdeaKindsResourceLinks", "exampleSetFlag" : false } ] }, "IdeaKindsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/IdeaKindsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/IdeaKindsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/IdeaKindsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/IdeaKindsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/IdeaKindsNameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/IdeaKindsActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/IdeaKindsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "sort_order" : { "$ref" : "#/components/schemas/IdeaKindsSort_orderResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/IdeaKindsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeaKindsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/IdeaKindsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/IdeaKindsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/IdeaKindsNameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/IdeaKindsActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/IdeaKindsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "sort_order" : { "$ref" : "#/components/schemas/IdeaKindsSort_orderResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/IdeaKindsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "IdeasResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "comments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideas/{id}/relationships/comments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideas/{id}/comments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "kind" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideas/{id}/relationships/kind" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideas/{id}/kind" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeaKindsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/IdeaKindsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "votes" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideas/{id}/relationships/votes" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideas/{id}/votes" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideas/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideas/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "kind_id" : { "$ref" : "#/components/schemas/IdeasKind_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/IdeasLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/IdeasApprovedResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/IdeasCreated_onResourceAttribute", "exampleSetFlag" : false }, "approved_or_rejected_on" : { "$ref" : "#/components/schemas/IdeasApproved_or_rejected_onResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/IdeasActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/IdeasLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "title" : { "$ref" : "#/components/schemas/IdeasTitleResourceAttribute", "exampleSetFlag" : false }, "author_id" : { "$ref" : "#/components/schemas/IdeasAuthor_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/IdeasCreated_byResourceAttribute", "exampleSetFlag" : false }, "content" : { "$ref" : "#/components/schemas/IdeasContentResourceAttribute", "exampleSetFlag" : false }, "approved_or_rejected_by" : { "$ref" : "#/components/schemas/IdeasApproved_or_rejected_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/IdeasPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/IdeasResourcePostAttributes", "exampleSetFlag" : false } ] }, "IdeasResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "kind_id" : { "$ref" : "#/components/schemas/IdeasKind_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/IdeasLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/IdeasApprovedResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/IdeasCreated_onResourceAttribute", "exampleSetFlag" : false }, "approved_or_rejected_on" : { "$ref" : "#/components/schemas/IdeasApproved_or_rejected_onResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/IdeasActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/IdeasLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "title" : { "$ref" : "#/components/schemas/IdeasTitleResourceAttribute", "exampleSetFlag" : false }, "author_id" : { "$ref" : "#/components/schemas/IdeasAuthor_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/IdeasCreated_byResourceAttribute", "exampleSetFlag" : false }, "content" : { "$ref" : "#/components/schemas/IdeasContentResourceAttribute", "exampleSetFlag" : false }, "approved_or_rejected_by" : { "$ref" : "#/components/schemas/IdeasApproved_or_rejected_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "IdeasPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeasPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "IdeasCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "IdeasPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ideas)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ideas" ] }, "id" : { "$ref" : "#/components/schemas/IdeasIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "IdeasAuthor_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "IdeasKindResourceAttribute" : { "$ref" : "#/components/schemas/IdeaKindsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "IdeasVotesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "IdeasResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/ideas/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "IdeasResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/IdeasResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "IdeasResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeasResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "IdeasApproved_or_rejected_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "IdeasResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "kind_id" : { "$ref" : "#/components/schemas/IdeasKind_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/IdeasLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/IdeasApprovedResourceAttribute", "exampleSetFlag" : false }, "approved_or_rejected_on" : { "$ref" : "#/components/schemas/IdeasApproved_or_rejected_onResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/IdeasActiveResourceAttribute", "exampleSetFlag" : false }, "title" : { "$ref" : "#/components/schemas/IdeasTitleResourceAttribute", "exampleSetFlag" : false }, "author_id" : { "$ref" : "#/components/schemas/IdeasAuthor_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/IdeasCreated_byResourceAttribute", "exampleSetFlag" : false }, "content" : { "$ref" : "#/components/schemas/IdeasContentResourceAttribute", "exampleSetFlag" : false }, "approved_or_rejected_by" : { "$ref" : "#/components/schemas/IdeasApproved_or_rejected_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasCommentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CommentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "IdeasResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/IdeasResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/IdeasResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/IdeasResourceLinks", "exampleSetFlag" : false } ] }, "IdeasContentResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "IdeasApproved_or_rejected_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "IdeasTitleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "IdeasResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ideas)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ideas" ] }, "id" : { "$ref" : "#/components/schemas/IdeasIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/IdeasResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "IdeasKind_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "IdeasApprovedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "IdeasEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "IdeasPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/IdeasPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "contract_id" : { "$ref" : "#/components/schemas/InvestigationDetailLinesContract_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/InvestigationDetailLinesActiveResourceAttribute", "exampleSetFlag" : false }, "detail_id" : { "$ref" : "#/components/schemas/InvestigationDetailLinesDetail_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCreated_byResourceAttribute", "exampleSetFlag" : false }, "report_sent" : { "$ref" : "#/components/schemas/InvestigationDetailLinesReport_sentResourceAttribute", "exampleSetFlag" : false }, "adjuster_time" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAdjuster_timeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationDetailLinesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "report_sent_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesReport_sent_dateResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/InvestigationDetailLinesContract_numberResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_ratio" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCount_against_quality_ratioResourceAttribute", "exampleSetFlag" : false }, "cdc_code" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCdc_codeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "billable_to_customer" : { "$ref" : "#/components/schemas/InvestigationDetailLinesBillable_to_customerResourceAttribute", "exampleSetFlag" : false }, "accepted_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAccepted_dateResourceAttribute", "exampleSetFlag" : false }, "att5" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt5ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/InvestigationDetailLinesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "att2" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt2ResourceAttribute", "exampleSetFlag" : false }, "att1" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt1ResourceAttribute", "exampleSetFlag" : false }, "att4" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt4ResourceAttribute", "exampleSetFlag" : false }, "att3" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt3ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailLinesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailLinesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationDetailLinesAtt2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "contract_id" : { "$ref" : "#/components/schemas/InvestigationDetailLinesContract_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/InvestigationDetailLinesActiveResourceAttribute", "exampleSetFlag" : false }, "detail_id" : { "$ref" : "#/components/schemas/InvestigationDetailLinesDetail_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCreated_byResourceAttribute", "exampleSetFlag" : false }, "report_sent" : { "$ref" : "#/components/schemas/InvestigationDetailLinesReport_sentResourceAttribute", "exampleSetFlag" : false }, "adjuster_time" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAdjuster_timeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationDetailLinesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "report_sent_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesReport_sent_dateResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/InvestigationDetailLinesContract_numberResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_ratio" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCount_against_quality_ratioResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCreated_onResourceAttribute", "exampleSetFlag" : false }, "cdc_code" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCdc_codeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "billable_to_customer" : { "$ref" : "#/components/schemas/InvestigationDetailLinesBillable_to_customerResourceAttribute", "exampleSetFlag" : false }, "accepted_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAccepted_dateResourceAttribute", "exampleSetFlag" : false }, "att5" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt5ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/InvestigationDetailLinesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "att2" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt2ResourceAttribute", "exampleSetFlag" : false }, "att1" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt1ResourceAttribute", "exampleSetFlag" : false }, "att4" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt4ResourceAttribute", "exampleSetFlag" : false }, "att3" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt3ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesDetail_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailLinesReport_sent_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailLinesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationDetailLinesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailLinesResourcePostAttributes", "exampleSetFlag" : false } ] }, "InvestigationDetailLinesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailLinesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationDetailLinesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesCount_against_quality_ratioResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationDetailLinesReport_sentResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationDetailLinesBillable_to_customerResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationDetailLinesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailLinesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "InvestigationDetailLinesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "InvestigationDetailLinesAtt3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigationDetailLines)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigationDetailLines" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationDetailLinesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesAdjuster_timeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailLinesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigationDetailLines)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigationDetailLines" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationDetailLinesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesCdc_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "InvestigationDetailLinesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "cmsInvestigationDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailLines/{id}/relationships/cmsInvestigationDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailLines/{id}/cmsInvestigationDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesAtt5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesContract_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceLinks", "exampleSetFlag" : false } ] }, "InvestigationDetailLinesContract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "contract_id" : { "$ref" : "#/components/schemas/InvestigationDetailLinesContract_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/InvestigationDetailLinesActiveResourceAttribute", "exampleSetFlag" : false }, "detail_id" : { "$ref" : "#/components/schemas/InvestigationDetailLinesDetail_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCreated_byResourceAttribute", "exampleSetFlag" : false }, "report_sent" : { "$ref" : "#/components/schemas/InvestigationDetailLinesReport_sentResourceAttribute", "exampleSetFlag" : false }, "adjuster_time" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAdjuster_timeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationDetailLinesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "report_sent_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesReport_sent_dateResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/InvestigationDetailLinesContract_numberResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_ratio" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCount_against_quality_ratioResourceAttribute", "exampleSetFlag" : false }, "cdc_code" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCdc_codeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/InvestigationDetailLinesCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "billable_to_customer" : { "$ref" : "#/components/schemas/InvestigationDetailLinesBillable_to_customerResourceAttribute", "exampleSetFlag" : false }, "accepted_date" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAccepted_dateResourceAttribute", "exampleSetFlag" : false }, "att5" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt5ResourceAttribute", "exampleSetFlag" : false }, "att2" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt2ResourceAttribute", "exampleSetFlag" : false }, "att1" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt1ResourceAttribute", "exampleSetFlag" : false }, "att4" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt4ResourceAttribute", "exampleSetFlag" : false }, "att3" : { "$ref" : "#/components/schemas/InvestigationDetailLinesAtt3ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailLinesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesAccepted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailLinesAtt1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesAtt4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailLinesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "InvestigationDetailLinesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesCmsInvestigationDetailResourceAttribute" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailLinesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailLines/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailLinesCustomer_claim_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsId_utilityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsId_other_indicatorsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsId_replacement_footageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsId_record_numbersResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "id_replacement_footage" : { "$ref" : "#/components/schemas/InvestigationDetailsId_replacement_footageResourceAttribute", "exampleSetFlag" : false }, "id_damage_customer" : { "$ref" : "#/components/schemas/InvestigationDetailsId_damage_customerResourceAttribute", "exampleSetFlag" : false }, "id_facility" : { "$ref" : "#/components/schemas/InvestigationDetailsId_facilityResourceAttribute", "exampleSetFlag" : false }, "id_record_numbers" : { "$ref" : "#/components/schemas/InvestigationDetailsId_record_numbersResourceAttribute", "exampleSetFlag" : false }, "inv_report_attachment_id" : { "$ref" : "#/components/schemas/InvestigationDetailsInv_report_attachment_idResourceAttribute", "exampleSetFlag" : false }, "id_utility" : { "$ref" : "#/components/schemas/InvestigationDetailsId_utilityResourceAttribute", "exampleSetFlag" : false }, "id_were_markings_visible" : { "$ref" : "#/components/schemas/InvestigationDetailsId_were_markings_visibleResourceAttribute", "exampleSetFlag" : false }, "id_customer_id" : { "$ref" : "#/components/schemas/InvestigationDetailsId_customer_idResourceAttribute", "exampleSetFlag" : false }, "id_cause_factor" : { "$ref" : "#/components/schemas/InvestigationDetailsId_cause_factorResourceAttribute", "exampleSetFlag" : false }, "id_damage_id" : { "$ref" : "#/components/schemas/InvestigationDetailsId_damage_idResourceAttribute", "exampleSetFlag" : false }, "id_contractor_equipment" : { "$ref" : "#/components/schemas/InvestigationDetailsId_contractor_equipmentResourceAttribute", "exampleSetFlag" : false }, "id_facility_type" : { "$ref" : "#/components/schemas/InvestigationDetailsId_facility_typeResourceAttribute", "exampleSetFlag" : false }, "id_other_indicators" : { "$ref" : "#/components/schemas/InvestigationDetailsId_other_indicatorsResourceAttribute", "exampleSetFlag" : false }, "id_contractor_assistance" : { "$ref" : "#/components/schemas/InvestigationDetailsId_contractor_assistanceResourceAttribute", "exampleSetFlag" : false }, "id_facility_shown" : { "$ref" : "#/components/schemas/InvestigationDetailsId_facility_shownResourceAttribute", "exampleSetFlag" : false }, "id_investigation_id" : { "$ref" : "#/components/schemas/InvestigationDetailsId_investigation_idResourceAttribute", "exampleSetFlag" : false }, "id_locator_name" : { "$ref" : "#/components/schemas/InvestigationDetailsId_locator_nameResourceAttribute", "exampleSetFlag" : false }, "id_tolerence_zone" : { "$ref" : "#/components/schemas/InvestigationDetailsId_tolerence_zoneResourceAttribute", "exampleSetFlag" : false }, "id_notification_id" : { "$ref" : "#/components/schemas/InvestigationDetailsId_notification_idResourceAttribute", "exampleSetFlag" : false }, "id_facility_damage" : { "$ref" : "#/components/schemas/InvestigationDetailsId_facility_damageResourceAttribute", "exampleSetFlag" : false }, "id_account_level_customer_id" : { "$ref" : "#/components/schemas/InvestigationDetailsId_account_level_customer_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsId_were_markings_visibleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsId_account_level_customer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "InvestigationDetailsId_customer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsId_damage_customerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsId_facility_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsId_damage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsPolicyDropOffEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationDetailsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "InvestigationDetailsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailsResourceLinks", "exampleSetFlag" : false } ] }, "InvestigationDetailsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigationDetails)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigationDetails" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationDetailsPostResourceReference", "exampleSetFlag" : false } ] }, "InvestigationDetailsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationDetailsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsClaimDetailsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationDetailsId_notification_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsId_facility_damageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsId_contractor_assistanceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsId_contractor_equipmentResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsId_tolerence_zoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "policyDropOffEstimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/relationships/policyDropOffEstimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/policyDropOffEstimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claimDetails" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/relationships/claimDetails" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/claimDetails" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationReport" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/relationships/investigationReport" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/investigationReport" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetailsVersions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/relationships/investigationDetailsVersions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetails/{id}/investigationDetailsVersions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsId_investigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsId_locator_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsInvestigationReportResourceAttribute" : { "$ref" : "#/components/schemas/DamagePhotosResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsInv_report_attachment_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsId_cause_factorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsInvestigationDetailsVersionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationDetailsId_facilityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsId_facility_shownResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigationDetails)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigationDetails" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceLinks", "exampleSetFlag" : false } ] }, "InvestigationDetailsVersionsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "investigation_version_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsInvestigation_version_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsActiveResourceAttribute", "exampleSetFlag" : false }, "investigation_root_cause_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsInvestigation_root_cause_idResourceAttribute", "exampleSetFlag" : false }, "changed_date" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsChanged_dateResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCompletedResourceAttribute", "exampleSetFlag" : false }, "detail_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsDetail_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCreated_byResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "changed_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsChanged_byResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsLocator_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsFacility_idResourceAttribute", "exampleSetFlag" : false }, "att5" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt5ResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "att2" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt2ResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCompleted_byResourceAttribute", "exampleSetFlag" : false }, "att1" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt1ResourceAttribute", "exampleSetFlag" : false }, "att4" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt4ResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsSearch_textResourceAttribute", "exampleSetFlag" : false }, "att3" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt3ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigationDetailsVersions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigationDetailsVersions" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsVersionsCmsCustomerResourceAttribute" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsVersionsActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationDetailsVersionsChanged_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsVersionsInvestigation_root_cause_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "investigation_version_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsInvestigation_version_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "changed_date" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsChanged_dateResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsLocator_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsFacility_idResourceAttribute", "exampleSetFlag" : false }, "att5" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt5ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "att2" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt2ResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCompleted_byResourceAttribute", "exampleSetFlag" : false }, "att1" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt1ResourceAttribute", "exampleSetFlag" : false }, "att4" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt4ResourceAttribute", "exampleSetFlag" : false }, "att3" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt3ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsActiveResourceAttribute", "exampleSetFlag" : false }, "investigation_root_cause_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsInvestigation_root_cause_idResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCompletedResourceAttribute", "exampleSetFlag" : false }, "detail_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsDetail_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCreated_byResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "changed_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsChanged_byResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsSearch_textResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsChanged_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsVersionsAtt1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsVersionsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsVersionsLocator_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsSearch_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsVersionsFacility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsInvestigationVersionResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsVersionsLocatorResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsVersionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsInvestigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationDetailsVersionsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourcePostAttributes", "exampleSetFlag" : false } ] }, "InvestigationDetailsVersionsAtt4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsVersionsCompletedByResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsVersionsAtt5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsVersionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsUtility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "investigation_version_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsInvestigation_version_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "changed_date" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsChanged_dateResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsLocator_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsFacility_idResourceAttribute", "exampleSetFlag" : false }, "att5" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt5ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "att2" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt2ResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCompleted_byResourceAttribute", "exampleSetFlag" : false }, "att1" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt1ResourceAttribute", "exampleSetFlag" : false }, "att4" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt4ResourceAttribute", "exampleSetFlag" : false }, "att3" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsAtt3ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsActiveResourceAttribute", "exampleSetFlag" : false }, "investigation_root_cause_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsInvestigation_root_cause_idResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCompletedResourceAttribute", "exampleSetFlag" : false }, "detail_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsDetail_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCreated_byResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "changed_by" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsChanged_byResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsSearch_textResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsAtt3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsVersionsChangedByResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsVersionsInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsVersionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "investigationVersion" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/relationships/investigationVersion" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/investigationVersion" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/relationships/investigationDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/investigationDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "changedBy" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/relationships/changedBy" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/changedBy" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsCustomer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/relationships/cmsCustomer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/cmsCustomer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsCustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locator" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/relationships/locator" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/locator" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "completedBy" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/relationships/completedBy" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationDetailsVersions/{id}/completedBy" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsCompletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationDetailsVersionsAtt2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationDetailsVersionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "InvestigationDetailsVersionsFacility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsInvestigation_version_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigationDetailsVersions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigationDetailsVersions" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationDetailsVersionsInvestigationDetailResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationDetailsVersionsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "InvestigationDetailsVersionsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "InvestigationDetailsVersionsCompleted_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationDetailsVersionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "InvestigationDetailsVersionsDetail_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsPics_taken_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsApproverResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsDig_up_dmg_ticketResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationVersionsBoringResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationVersionsAdd_1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsLocator_last_nmResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsLocator_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsTicket_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsAdd_2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "picsTakenByEmployee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/relationships/picsTakenByEmployee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/picsTakenByEmployee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "approverEmployee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/relationships/approverEmployee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/approverEmployee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetailsVersions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/relationships/investigationDetailsVersions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}/investigationDetailsVersions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsExcavation_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsChange_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigationVersions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsExcavator_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "InvestigationVersionsDig_up_dmg_reqResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsLatitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "InvestigationVersionsPost_approver_changeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationVersionsApproved_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsDamage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsType_of_workResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsExcavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsInvestigationDetailsVersionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationVersionsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "InvestigationVersionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsSearch_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsCompletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationVersionsInv_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationVersionsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsCustomer_claim_number_2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsTicket_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ticket_type" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_typeResourceAttribute", "exampleSetFlag" : false }, "pics_taken_by" : { "$ref" : "#/components/schemas/InvestigationVersionsPics_taken_byResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_req" : { "$ref" : "#/components/schemas/InvestigationVersionsDig_up_dmg_reqResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/InvestigationVersionsStateidResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/InvestigationVersionsCountyResourceAttribute", "exampleSetFlag" : false }, "changed_date" : { "$ref" : "#/components/schemas/InvestigationVersionsChanged_dateResourceAttribute", "exampleSetFlag" : false }, "change_reason_text" : { "$ref" : "#/components/schemas/InvestigationVersionsChange_reason_textResourceAttribute", "exampleSetFlag" : false }, "excavation_type_id" : { "$ref" : "#/components/schemas/InvestigationVersionsExcavation_type_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/InvestigationVersionsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "add_2" : { "$ref" : "#/components/schemas/InvestigationVersionsAdd_2ResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/InvestigationVersionsApprovedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationVersionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "inv_end_date" : { "$ref" : "#/components/schemas/InvestigationVersionsInv_end_dateResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_ticket" : { "$ref" : "#/components/schemas/InvestigationVersionsDig_up_dmg_ticketResourceAttribute", "exampleSetFlag" : false }, "add_1" : { "$ref" : "#/components/schemas/InvestigationVersionsAdd_1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/InvestigationVersionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/InvestigationVersionsDamage_idResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/InvestigationVersionsLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/InvestigationVersionsZipResourceAttribute", "exampleSetFlag" : false }, "cross_str1" : { "$ref" : "#/components/schemas/InvestigationVersionsCross_str1ResourceAttribute", "exampleSetFlag" : false }, "geo_location" : { "$ref" : "#/components/schemas/InvestigationVersionsGeo_locationResourceAttribute", "exampleSetFlag" : false }, "locator_first_nm" : { "$ref" : "#/components/schemas/InvestigationVersionsLocator_first_nmResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/InvestigationVersionsCompletedResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationVersionsCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/InvestigationVersionsCountryidResourceAttribute", "exampleSetFlag" : false }, "post_approver_change" : { "$ref" : "#/components/schemas/InvestigationVersionsPost_approver_changeResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/InvestigationVersionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "locator_last_nm" : { "$ref" : "#/components/schemas/InvestigationVersionsLocator_last_nmResourceAttribute", "exampleSetFlag" : false }, "changed_by" : { "$ref" : "#/components/schemas/InvestigationVersionsChanged_byResourceAttribute", "exampleSetFlag" : false }, "ticket_closed_date" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_closed_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/InvestigationVersionsSearch_textResourceAttribute", "exampleSetFlag" : false }, "inv_start_date" : { "$ref" : "#/components/schemas/InvestigationVersionsInv_start_dateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/InvestigationVersionsCityResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/InvestigationVersionsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/InvestigationVersionsLatitudeResourceAttribute", "exampleSetFlag" : false }, "approved_date" : { "$ref" : "#/components/schemas/InvestigationVersionsApproved_dateResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/InvestigationVersionsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_ticket_id" : { "$ref" : "#/components/schemas/InvestigationVersionsOne_call_request_ticket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/InvestigationVersionsExcavatorResourceAttribute", "exampleSetFlag" : false }, "excavator_id" : { "$ref" : "#/components/schemas/InvestigationVersionsExcavator_idResourceAttribute", "exampleSetFlag" : false }, "change_reason_id" : { "$ref" : "#/components/schemas/InvestigationVersionsChange_reason_idResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/InvestigationVersionsLocator_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/InvestigationVersionsCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "cross_str2" : { "$ref" : "#/components/schemas/InvestigationVersionsCross_str2ResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/InvestigationVersionsApproverResourceAttribute", "exampleSetFlag" : false }, "owner" : { "$ref" : "#/components/schemas/InvestigationVersionsOwnerResourceAttribute", "exampleSetFlag" : false }, "ticket_start_date" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_start_dateResourceAttribute", "exampleSetFlag" : false }, "type_of_work" : { "$ref" : "#/components/schemas/InvestigationVersionsType_of_workResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/InvestigationVersionsBoringResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/InvestigationVersionsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number_2" : { "$ref" : "#/components/schemas/InvestigationVersionsCustomer_claim_number_2ResourceAttribute", "exampleSetFlag" : false }, "dots_number" : { "$ref" : "#/components/schemas/InvestigationVersionsDots_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationVersionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsCross_str1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationVersionsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationVersionsResourcePostAttributes", "exampleSetFlag" : false } ] }, "InvestigationVersionsApproverEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigationVersions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigationVersions" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationVersionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsApprovedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationVersionsZipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ticket_type" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_typeResourceAttribute", "exampleSetFlag" : false }, "pics_taken_by" : { "$ref" : "#/components/schemas/InvestigationVersionsPics_taken_byResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_req" : { "$ref" : "#/components/schemas/InvestigationVersionsDig_up_dmg_reqResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/InvestigationVersionsStateidResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/InvestigationVersionsCountyResourceAttribute", "exampleSetFlag" : false }, "changed_date" : { "$ref" : "#/components/schemas/InvestigationVersionsChanged_dateResourceAttribute", "exampleSetFlag" : false }, "change_reason_text" : { "$ref" : "#/components/schemas/InvestigationVersionsChange_reason_textResourceAttribute", "exampleSetFlag" : false }, "excavation_type_id" : { "$ref" : "#/components/schemas/InvestigationVersionsExcavation_type_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/InvestigationVersionsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "add_2" : { "$ref" : "#/components/schemas/InvestigationVersionsAdd_2ResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/InvestigationVersionsApprovedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationVersionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "inv_end_date" : { "$ref" : "#/components/schemas/InvestigationVersionsInv_end_dateResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_ticket" : { "$ref" : "#/components/schemas/InvestigationVersionsDig_up_dmg_ticketResourceAttribute", "exampleSetFlag" : false }, "add_1" : { "$ref" : "#/components/schemas/InvestigationVersionsAdd_1ResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/InvestigationVersionsDamage_idResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/InvestigationVersionsLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/InvestigationVersionsZipResourceAttribute", "exampleSetFlag" : false }, "cross_str1" : { "$ref" : "#/components/schemas/InvestigationVersionsCross_str1ResourceAttribute", "exampleSetFlag" : false }, "geo_location" : { "$ref" : "#/components/schemas/InvestigationVersionsGeo_locationResourceAttribute", "exampleSetFlag" : false }, "locator_first_nm" : { "$ref" : "#/components/schemas/InvestigationVersionsLocator_first_nmResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/InvestigationVersionsCompletedResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationVersionsCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/InvestigationVersionsCountryidResourceAttribute", "exampleSetFlag" : false }, "post_approver_change" : { "$ref" : "#/components/schemas/InvestigationVersionsPost_approver_changeResourceAttribute", "exampleSetFlag" : false }, "locator_last_nm" : { "$ref" : "#/components/schemas/InvestigationVersionsLocator_last_nmResourceAttribute", "exampleSetFlag" : false }, "changed_by" : { "$ref" : "#/components/schemas/InvestigationVersionsChanged_byResourceAttribute", "exampleSetFlag" : false }, "ticket_closed_date" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_closed_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/InvestigationVersionsSearch_textResourceAttribute", "exampleSetFlag" : false }, "inv_start_date" : { "$ref" : "#/components/schemas/InvestigationVersionsInv_start_dateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/InvestigationVersionsCityResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/InvestigationVersionsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/InvestigationVersionsLatitudeResourceAttribute", "exampleSetFlag" : false }, "approved_date" : { "$ref" : "#/components/schemas/InvestigationVersionsApproved_dateResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/InvestigationVersionsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_ticket_id" : { "$ref" : "#/components/schemas/InvestigationVersionsOne_call_request_ticket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/InvestigationVersionsExcavatorResourceAttribute", "exampleSetFlag" : false }, "excavator_id" : { "$ref" : "#/components/schemas/InvestigationVersionsExcavator_idResourceAttribute", "exampleSetFlag" : false }, "change_reason_id" : { "$ref" : "#/components/schemas/InvestigationVersionsChange_reason_idResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/InvestigationVersionsLocator_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/InvestigationVersionsCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "cross_str2" : { "$ref" : "#/components/schemas/InvestigationVersionsCross_str2ResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/InvestigationVersionsApproverResourceAttribute", "exampleSetFlag" : false }, "owner" : { "$ref" : "#/components/schemas/InvestigationVersionsOwnerResourceAttribute", "exampleSetFlag" : false }, "ticket_start_date" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_start_dateResourceAttribute", "exampleSetFlag" : false }, "type_of_work" : { "$ref" : "#/components/schemas/InvestigationVersionsType_of_workResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/InvestigationVersionsBoringResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/InvestigationVersionsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number_2" : { "$ref" : "#/components/schemas/InvestigationVersionsCustomer_claim_number_2ResourceAttribute", "exampleSetFlag" : false }, "dots_number" : { "$ref" : "#/components/schemas/InvestigationVersionsDots_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsStateidResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "InvestigationVersionsInvestigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsLongitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "InvestigationVersionsCross_str2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsOwnerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsOne_call_request_ticket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsTicket_closed_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsLocator_first_nmResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsPicsTakenByEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationVersionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationVersionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationVersionsResourceLinks", "exampleSetFlag" : false } ] }, "InvestigationVersionsChanged_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsChanged_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsChange_reason_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "InvestigationVersionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsInv_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationVersionsCustomer_claim_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ticket_type" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_typeResourceAttribute", "exampleSetFlag" : false }, "pics_taken_by" : { "$ref" : "#/components/schemas/InvestigationVersionsPics_taken_byResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_req" : { "$ref" : "#/components/schemas/InvestigationVersionsDig_up_dmg_reqResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/InvestigationVersionsStateidResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/InvestigationVersionsCountyResourceAttribute", "exampleSetFlag" : false }, "changed_date" : { "$ref" : "#/components/schemas/InvestigationVersionsChanged_dateResourceAttribute", "exampleSetFlag" : false }, "change_reason_text" : { "$ref" : "#/components/schemas/InvestigationVersionsChange_reason_textResourceAttribute", "exampleSetFlag" : false }, "excavation_type_id" : { "$ref" : "#/components/schemas/InvestigationVersionsExcavation_type_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/InvestigationVersionsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "add_2" : { "$ref" : "#/components/schemas/InvestigationVersionsAdd_2ResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/InvestigationVersionsApprovedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationVersionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "inv_end_date" : { "$ref" : "#/components/schemas/InvestigationVersionsInv_end_dateResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_ticket" : { "$ref" : "#/components/schemas/InvestigationVersionsDig_up_dmg_ticketResourceAttribute", "exampleSetFlag" : false }, "add_1" : { "$ref" : "#/components/schemas/InvestigationVersionsAdd_1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/InvestigationVersionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/InvestigationVersionsDamage_idResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/InvestigationVersionsLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/InvestigationVersionsZipResourceAttribute", "exampleSetFlag" : false }, "cross_str1" : { "$ref" : "#/components/schemas/InvestigationVersionsCross_str1ResourceAttribute", "exampleSetFlag" : false }, "geo_location" : { "$ref" : "#/components/schemas/InvestigationVersionsGeo_locationResourceAttribute", "exampleSetFlag" : false }, "locator_first_nm" : { "$ref" : "#/components/schemas/InvestigationVersionsLocator_first_nmResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/InvestigationVersionsCompletedResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationVersionsCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/InvestigationVersionsCountryidResourceAttribute", "exampleSetFlag" : false }, "post_approver_change" : { "$ref" : "#/components/schemas/InvestigationVersionsPost_approver_changeResourceAttribute", "exampleSetFlag" : false }, "locator_last_nm" : { "$ref" : "#/components/schemas/InvestigationVersionsLocator_last_nmResourceAttribute", "exampleSetFlag" : false }, "changed_by" : { "$ref" : "#/components/schemas/InvestigationVersionsChanged_byResourceAttribute", "exampleSetFlag" : false }, "ticket_closed_date" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_closed_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/InvestigationVersionsSearch_textResourceAttribute", "exampleSetFlag" : false }, "inv_start_date" : { "$ref" : "#/components/schemas/InvestigationVersionsInv_start_dateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/InvestigationVersionsCityResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/InvestigationVersionsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/InvestigationVersionsLatitudeResourceAttribute", "exampleSetFlag" : false }, "approved_date" : { "$ref" : "#/components/schemas/InvestigationVersionsApproved_dateResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/InvestigationVersionsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_ticket_id" : { "$ref" : "#/components/schemas/InvestigationVersionsOne_call_request_ticket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/InvestigationVersionsExcavatorResourceAttribute", "exampleSetFlag" : false }, "excavator_id" : { "$ref" : "#/components/schemas/InvestigationVersionsExcavator_idResourceAttribute", "exampleSetFlag" : false }, "change_reason_id" : { "$ref" : "#/components/schemas/InvestigationVersionsChange_reason_idResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/InvestigationVersionsLocator_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/InvestigationVersionsCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "cross_str2" : { "$ref" : "#/components/schemas/InvestigationVersionsCross_str2ResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/InvestigationVersionsApproverResourceAttribute", "exampleSetFlag" : false }, "owner" : { "$ref" : "#/components/schemas/InvestigationVersionsOwnerResourceAttribute", "exampleSetFlag" : false }, "ticket_start_date" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_start_dateResourceAttribute", "exampleSetFlag" : false }, "type_of_work" : { "$ref" : "#/components/schemas/InvestigationVersionsType_of_workResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/InvestigationVersionsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/InvestigationVersionsBoringResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/InvestigationVersionsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number_2" : { "$ref" : "#/components/schemas/InvestigationVersionsCustomer_claim_number_2ResourceAttribute", "exampleSetFlag" : false }, "dots_number" : { "$ref" : "#/components/schemas/InvestigationVersionsDots_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationVersionsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsDots_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsCountryidResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationVersionsGeo_locationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationVersionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigationVersions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigationVersions" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationVersionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsInvestigationDetailsVersionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsOwnerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "InvestigationsExcavator_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsDig_up_dmg_reqResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ticket_type" : { "$ref" : "#/components/schemas/InvestigationsTicket_typeResourceAttribute", "exampleSetFlag" : false }, "pics_taken_by" : { "$ref" : "#/components/schemas/InvestigationsPics_taken_byResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_req" : { "$ref" : "#/components/schemas/InvestigationsDig_up_dmg_reqResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/InvestigationsStateidResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/InvestigationsCountyResourceAttribute", "exampleSetFlag" : false }, "change_reason_text" : { "$ref" : "#/components/schemas/InvestigationsChange_reason_textResourceAttribute", "exampleSetFlag" : false }, "excavation_type_id" : { "$ref" : "#/components/schemas/InvestigationsExcavation_type_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/InvestigationsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "add_2" : { "$ref" : "#/components/schemas/InvestigationsAdd_2ResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/InvestigationsApprovedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "inv_end_date" : { "$ref" : "#/components/schemas/InvestigationsInv_end_dateResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_ticket" : { "$ref" : "#/components/schemas/InvestigationsDig_up_dmg_ticketResourceAttribute", "exampleSetFlag" : false }, "add_1" : { "$ref" : "#/components/schemas/InvestigationsAdd_1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/InvestigationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/InvestigationsDamage_idResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/InvestigationsLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/InvestigationsZipResourceAttribute", "exampleSetFlag" : false }, "cross_str1" : { "$ref" : "#/components/schemas/InvestigationsCross_str1ResourceAttribute", "exampleSetFlag" : false }, "locator_first_nm" : { "$ref" : "#/components/schemas/InvestigationsLocator_first_nmResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/InvestigationsCompletedResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/InvestigationsCountryidResourceAttribute", "exampleSetFlag" : false }, "post_approver_change" : { "$ref" : "#/components/schemas/InvestigationsPost_approver_changeResourceAttribute", "exampleSetFlag" : false }, "locator_last_nm" : { "$ref" : "#/components/schemas/InvestigationsLocator_last_nmResourceAttribute", "exampleSetFlag" : false }, "ticket_closed_date" : { "$ref" : "#/components/schemas/InvestigationsTicket_closed_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/InvestigationsSearch_textResourceAttribute", "exampleSetFlag" : false }, "inv_start_date" : { "$ref" : "#/components/schemas/InvestigationsInv_start_dateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/InvestigationsCityResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/InvestigationsLatitudeResourceAttribute", "exampleSetFlag" : false }, "approved_date" : { "$ref" : "#/components/schemas/InvestigationsApproved_dateResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/InvestigationsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_ticket_id" : { "$ref" : "#/components/schemas/InvestigationsOne_call_request_ticket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/InvestigationsExcavatorResourceAttribute", "exampleSetFlag" : false }, "excavator_id" : { "$ref" : "#/components/schemas/InvestigationsExcavator_idResourceAttribute", "exampleSetFlag" : false }, "change_reason_id" : { "$ref" : "#/components/schemas/InvestigationsChange_reason_idResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/InvestigationsLocator_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/InvestigationsCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "cross_str2" : { "$ref" : "#/components/schemas/InvestigationsCross_str2ResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/InvestigationsApproverResourceAttribute", "exampleSetFlag" : false }, "owner" : { "$ref" : "#/components/schemas/InvestigationsOwnerResourceAttribute", "exampleSetFlag" : false }, "ticket_start_date" : { "$ref" : "#/components/schemas/InvestigationsTicket_start_dateResourceAttribute", "exampleSetFlag" : false }, "type_of_work" : { "$ref" : "#/components/schemas/InvestigationsType_of_workResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/InvestigationsTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/InvestigationsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/InvestigationsBoringResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/InvestigationsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number_2" : { "$ref" : "#/components/schemas/InvestigationsCustomer_claim_number_2ResourceAttribute", "exampleSetFlag" : false }, "dots_number" : { "$ref" : "#/components/schemas/InvestigationsDots_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "InvestigationsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsZipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsTicket_closed_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationsExcavatResourceAttribute" : { "$ref" : "#/components/schemas/ExcavatorResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsApproved_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsExcavationTypeResourceAttribute" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsDig_up_dmg_ticketResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationsCompletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationsChange_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsCmsInvestigationDetailsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationsSearch_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsInv_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "InvestigationsPolicyDropOffEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationsInvestigationDetailsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationsPics_taken_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigations" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsApproverResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsCross_str1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsBoringResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationsLongitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "InvestigationsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsChange_reason_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsDamage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsExcavation_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsQuestionnaireAnswersResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationsPost_approver_changeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ticket_type" : { "$ref" : "#/components/schemas/InvestigationsTicket_typeResourceAttribute", "exampleSetFlag" : false }, "pics_taken_by" : { "$ref" : "#/components/schemas/InvestigationsPics_taken_byResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_req" : { "$ref" : "#/components/schemas/InvestigationsDig_up_dmg_reqResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/InvestigationsStateidResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/InvestigationsCountyResourceAttribute", "exampleSetFlag" : false }, "change_reason_text" : { "$ref" : "#/components/schemas/InvestigationsChange_reason_textResourceAttribute", "exampleSetFlag" : false }, "excavation_type_id" : { "$ref" : "#/components/schemas/InvestigationsExcavation_type_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/InvestigationsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "add_2" : { "$ref" : "#/components/schemas/InvestigationsAdd_2ResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/InvestigationsApprovedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "inv_end_date" : { "$ref" : "#/components/schemas/InvestigationsInv_end_dateResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_ticket" : { "$ref" : "#/components/schemas/InvestigationsDig_up_dmg_ticketResourceAttribute", "exampleSetFlag" : false }, "add_1" : { "$ref" : "#/components/schemas/InvestigationsAdd_1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/InvestigationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/InvestigationsDamage_idResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/InvestigationsLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/InvestigationsZipResourceAttribute", "exampleSetFlag" : false }, "cross_str1" : { "$ref" : "#/components/schemas/InvestigationsCross_str1ResourceAttribute", "exampleSetFlag" : false }, "geo_location" : { "$ref" : "#/components/schemas/InvestigationsGeo_locationResourceAttribute", "exampleSetFlag" : false }, "locator_first_nm" : { "$ref" : "#/components/schemas/InvestigationsLocator_first_nmResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/InvestigationsCompletedResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/InvestigationsCountryidResourceAttribute", "exampleSetFlag" : false }, "post_approver_change" : { "$ref" : "#/components/schemas/InvestigationsPost_approver_changeResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/InvestigationsCreated_onResourceAttribute", "exampleSetFlag" : false }, "locator_last_nm" : { "$ref" : "#/components/schemas/InvestigationsLocator_last_nmResourceAttribute", "exampleSetFlag" : false }, "ticket_closed_date" : { "$ref" : "#/components/schemas/InvestigationsTicket_closed_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/InvestigationsSearch_textResourceAttribute", "exampleSetFlag" : false }, "inv_start_date" : { "$ref" : "#/components/schemas/InvestigationsInv_start_dateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/InvestigationsCityResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/InvestigationsLatitudeResourceAttribute", "exampleSetFlag" : false }, "approved_date" : { "$ref" : "#/components/schemas/InvestigationsApproved_dateResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/InvestigationsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "one_call_request_ticket_id" : { "$ref" : "#/components/schemas/InvestigationsOne_call_request_ticket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/InvestigationsExcavatorResourceAttribute", "exampleSetFlag" : false }, "excavator_id" : { "$ref" : "#/components/schemas/InvestigationsExcavator_idResourceAttribute", "exampleSetFlag" : false }, "change_reason_id" : { "$ref" : "#/components/schemas/InvestigationsChange_reason_idResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/InvestigationsLocator_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/InvestigationsCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "cross_str2" : { "$ref" : "#/components/schemas/InvestigationsCross_str2ResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/InvestigationsApproverResourceAttribute", "exampleSetFlag" : false }, "owner" : { "$ref" : "#/components/schemas/InvestigationsOwnerResourceAttribute", "exampleSetFlag" : false }, "ticket_start_date" : { "$ref" : "#/components/schemas/InvestigationsTicket_start_dateResourceAttribute", "exampleSetFlag" : false }, "questionaireAnswersVersions" : { "$ref" : "#/components/schemas/InvestigationsQuestionaireAnswersVersionsResourceAttribute", "exampleSetFlag" : false }, "type_of_work" : { "$ref" : "#/components/schemas/InvestigationsType_of_workResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/InvestigationsTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/InvestigationsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/InvestigationsBoringResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/InvestigationsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number_2" : { "$ref" : "#/components/schemas/InvestigationsCustomer_claim_number_2ResourceAttribute", "exampleSetFlag" : false }, "dots_number" : { "$ref" : "#/components/schemas/InvestigationsDots_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsLocator_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsPicsTakenEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationsResourcePostAttributes", "exampleSetFlag" : false } ] }, "InvestigationsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsApprovedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "InvestigationsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsCountryidResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsTicket_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsType_of_workResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsLatitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "InvestigationsDots_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsAdd_2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "InvestigationsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/InvestigationsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsExcavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsQuestionaireAnswersVersionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationsLocator_last_nmResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsInvestigationVersionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "InvestigationsAdd_1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/InvestigationsResourceLinks", "exampleSetFlag" : false } ] }, "InvestigationsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "inv_start_date" : { "$ref" : "#/components/schemas/InvestigationsInv_start_dateResourceAttribute", "exampleSetFlag" : false }, "ticket_type" : { "$ref" : "#/components/schemas/InvestigationsTicket_typeResourceAttribute", "exampleSetFlag" : false }, "pics_taken_by" : { "$ref" : "#/components/schemas/InvestigationsPics_taken_byResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/InvestigationsCityResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_req" : { "$ref" : "#/components/schemas/InvestigationsDig_up_dmg_reqResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/InvestigationsStateidResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/InvestigationsLatitudeResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/InvestigationsCountyResourceAttribute", "exampleSetFlag" : false }, "change_reason_text" : { "$ref" : "#/components/schemas/InvestigationsChange_reason_textResourceAttribute", "exampleSetFlag" : false }, "excavation_type_id" : { "$ref" : "#/components/schemas/InvestigationsExcavation_type_idResourceAttribute", "exampleSetFlag" : false }, "approved_date" : { "$ref" : "#/components/schemas/InvestigationsApproved_dateResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/InvestigationsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/InvestigationsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "add_2" : { "$ref" : "#/components/schemas/InvestigationsAdd_2ResourceAttribute", "exampleSetFlag" : false }, "approved" : { "$ref" : "#/components/schemas/InvestigationsApprovedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/InvestigationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "one_call_request_ticket_id" : { "$ref" : "#/components/schemas/InvestigationsOne_call_request_ticket_idResourceAttribute", "exampleSetFlag" : false }, "inv_end_date" : { "$ref" : "#/components/schemas/InvestigationsInv_end_dateResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/InvestigationsExcavatorResourceAttribute", "exampleSetFlag" : false }, "dig_up_dmg_ticket" : { "$ref" : "#/components/schemas/InvestigationsDig_up_dmg_ticketResourceAttribute", "exampleSetFlag" : false }, "excavator_id" : { "$ref" : "#/components/schemas/InvestigationsExcavator_idResourceAttribute", "exampleSetFlag" : false }, "add_1" : { "$ref" : "#/components/schemas/InvestigationsAdd_1ResourceAttribute", "exampleSetFlag" : false }, "change_reason_id" : { "$ref" : "#/components/schemas/InvestigationsChange_reason_idResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/InvestigationsLocator_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number" : { "$ref" : "#/components/schemas/InvestigationsCustomer_claim_numberResourceAttribute", "exampleSetFlag" : false }, "cross_str2" : { "$ref" : "#/components/schemas/InvestigationsCross_str2ResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/InvestigationsDamage_idResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/InvestigationsLongitudeResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/InvestigationsApproverResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/InvestigationsZipResourceAttribute", "exampleSetFlag" : false }, "owner" : { "$ref" : "#/components/schemas/InvestigationsOwnerResourceAttribute", "exampleSetFlag" : false }, "cross_str1" : { "$ref" : "#/components/schemas/InvestigationsCross_str1ResourceAttribute", "exampleSetFlag" : false }, "ticket_start_date" : { "$ref" : "#/components/schemas/InvestigationsTicket_start_dateResourceAttribute", "exampleSetFlag" : false }, "locator_first_nm" : { "$ref" : "#/components/schemas/InvestigationsLocator_first_nmResourceAttribute", "exampleSetFlag" : false }, "type_of_work" : { "$ref" : "#/components/schemas/InvestigationsType_of_workResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/InvestigationsCompletedResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/InvestigationsTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/InvestigationsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/InvestigationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/InvestigationsCountryidResourceAttribute", "exampleSetFlag" : false }, "post_approver_change" : { "$ref" : "#/components/schemas/InvestigationsPost_approver_changeResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/InvestigationsBoringResourceAttribute", "exampleSetFlag" : false }, "locator_last_nm" : { "$ref" : "#/components/schemas/InvestigationsLocator_last_nmResourceAttribute", "exampleSetFlag" : false }, "ticket_closed_date" : { "$ref" : "#/components/schemas/InvestigationsTicket_closed_dateResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/InvestigationsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "customer_claim_number_2" : { "$ref" : "#/components/schemas/InvestigationsCustomer_claim_number_2ResourceAttribute", "exampleSetFlag" : false }, "dots_number" : { "$ref" : "#/components/schemas/InvestigationsDots_numberResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/InvestigationsSearch_textResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsGeo_locationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsOne_call_request_ticket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsCustomer_claim_number_2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "policyDropOffEstimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/policyDropOffEstimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/policyDropOffEstimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "excavat" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/excavat" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/excavat" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ExcavatorResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ExcavatorResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationVersions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/investigationVersions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/investigationVersions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetails" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/investigationDetails" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/investigationDetails" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsInvestigationDetails" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/cmsInvestigationDetails" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/cmsInvestigationDetails" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "questionnaireAnswers" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/questionnaireAnswers" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/questionnaireAnswers" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "excavationType" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/excavationType" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/excavationType" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetailsVersions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/investigationDetailsVersions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/investigationDetailsVersions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "picsTakenEmployee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/picsTakenEmployee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/picsTakenEmployee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "estimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/relationships/estimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}/estimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/investigations/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "InvestigationsInv_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsLocator_first_nmResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsTicket_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "InvestigationsStateidResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "InvestigationsCustomer_claim_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsCross_str2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "InvestigationsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (investigations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "investigations" ] }, "id" : { "$ref" : "#/components/schemas/InvestigationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsJournal_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "JournalsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/JournalsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsCreatedByResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "JournalsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/JournalsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/JournalsResourcePostAttributes", "exampleSetFlag" : false } ] }, "JournalsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "journal_date" : { "$ref" : "#/components/schemas/JournalsJournal_dateResourceAttribute", "exampleSetFlag" : false }, "app_bread_crumbs_id" : { "$ref" : "#/components/schemas/JournalsApp_bread_crumbs_idResourceAttribute", "exampleSetFlag" : false }, "reminder_date" : { "$ref" : "#/components/schemas/JournalsReminder_dateResourceAttribute", "exampleSetFlag" : false }, "due_date" : { "$ref" : "#/components/schemas/JournalsDue_dateResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/JournalsActiveResourceAttribute", "exampleSetFlag" : false }, "journal_text" : { "$ref" : "#/components/schemas/JournalsJournal_textResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/JournalsCreated_byResourceAttribute", "exampleSetFlag" : false }, "reminder_flag" : { "$ref" : "#/components/schemas/JournalsReminder_flagResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/JournalsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/JournalsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "category_id" : { "$ref" : "#/components/schemas/JournalsCategory_idResourceAttribute", "exampleSetFlag" : false }, "pk2" : { "$ref" : "#/components/schemas/JournalsPk2ResourceAttribute", "exampleSetFlag" : false }, "pk1" : { "$ref" : "#/components/schemas/JournalsPk1ResourceAttribute", "exampleSetFlag" : false }, "pk3" : { "$ref" : "#/components/schemas/JournalsPk3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_by_id" : { "$ref" : "#/components/schemas/JournalsLast_updated_by_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/JournalsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "priv" : { "$ref" : "#/components/schemas/JournalsPrivResourceAttribute", "exampleSetFlag" : false }, "created_by_id" : { "$ref" : "#/components/schemas/JournalsCreated_by_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "JournalsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "journal_date" : { "$ref" : "#/components/schemas/JournalsJournal_dateResourceAttribute", "exampleSetFlag" : false }, "app_bread_crumbs_id" : { "$ref" : "#/components/schemas/JournalsApp_bread_crumbs_idResourceAttribute", "exampleSetFlag" : false }, "reminder_date" : { "$ref" : "#/components/schemas/JournalsReminder_dateResourceAttribute", "exampleSetFlag" : false }, "due_date" : { "$ref" : "#/components/schemas/JournalsDue_dateResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/JournalsActiveResourceAttribute", "exampleSetFlag" : false }, "journal_text" : { "$ref" : "#/components/schemas/JournalsJournal_textResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/JournalsCreated_byResourceAttribute", "exampleSetFlag" : false }, "reminder_flag" : { "$ref" : "#/components/schemas/JournalsReminder_flagResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/JournalsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/JournalsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "category_id" : { "$ref" : "#/components/schemas/JournalsCategory_idResourceAttribute", "exampleSetFlag" : false }, "pk2" : { "$ref" : "#/components/schemas/JournalsPk2ResourceAttribute", "exampleSetFlag" : false }, "pk1" : { "$ref" : "#/components/schemas/JournalsPk1ResourceAttribute", "exampleSetFlag" : false }, "pk3" : { "$ref" : "#/components/schemas/JournalsPk3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_by_id" : { "$ref" : "#/components/schemas/JournalsLast_updated_by_idResourceAttribute", "exampleSetFlag" : false }, "priv" : { "$ref" : "#/components/schemas/JournalsPrivResourceAttribute", "exampleSetFlag" : false }, "created_by_id" : { "$ref" : "#/components/schemas/JournalsCreated_by_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsLast_updated_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "JournalsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/JournalsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/JournalsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/JournalsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/JournalsResourceLinks", "exampleSetFlag" : false } ] }, "JournalsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/JournalsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/JournalsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/JournalsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsPrivResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "JournalsJournal_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "JournalsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "JournalsCategory_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "JournalsPk1ResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "JournalsReminder_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "JournalsCreated_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "JournalsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/JournalsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsReminder_flagResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "JournalsApp_bread_crumbs_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "JournalsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (journals)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "journals" ] }, "id" : { "$ref" : "#/components/schemas/JournalsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsPk2ResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "JournalsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/JournalsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "JournalsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "JournalsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/journals/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "JournalsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "updatedBy" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/journals/{id}/relationships/updatedBy" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/journals/{id}/updatedBy" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "createdBy" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/journals/{id}/relationships/createdBy" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/journals/{id}/createdBy" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsDue_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "JournalsUpdatedByResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "JournalsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (journals)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "journals" ] }, "id" : { "$ref" : "#/components/schemas/JournalsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "journal_date" : { "$ref" : "#/components/schemas/JournalsJournal_dateResourceAttribute", "exampleSetFlag" : false }, "app_bread_crumbs_id" : { "$ref" : "#/components/schemas/JournalsApp_bread_crumbs_idResourceAttribute", "exampleSetFlag" : false }, "reminder_date" : { "$ref" : "#/components/schemas/JournalsReminder_dateResourceAttribute", "exampleSetFlag" : false }, "due_date" : { "$ref" : "#/components/schemas/JournalsDue_dateResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/JournalsActiveResourceAttribute", "exampleSetFlag" : false }, "journal_text" : { "$ref" : "#/components/schemas/JournalsJournal_textResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/JournalsCreated_byResourceAttribute", "exampleSetFlag" : false }, "reminder_flag" : { "$ref" : "#/components/schemas/JournalsReminder_flagResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/JournalsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/JournalsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "category_id" : { "$ref" : "#/components/schemas/JournalsCategory_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/JournalsCreated_onResourceAttribute", "exampleSetFlag" : false }, "pk2" : { "$ref" : "#/components/schemas/JournalsPk2ResourceAttribute", "exampleSetFlag" : false }, "pk1" : { "$ref" : "#/components/schemas/JournalsPk1ResourceAttribute", "exampleSetFlag" : false }, "pk3" : { "$ref" : "#/components/schemas/JournalsPk3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_by_id" : { "$ref" : "#/components/schemas/JournalsLast_updated_by_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/JournalsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "priv" : { "$ref" : "#/components/schemas/JournalsPrivResourceAttribute", "exampleSetFlag" : false }, "created_by_id" : { "$ref" : "#/components/schemas/JournalsCreated_by_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/JournalsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "JournalsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/JournalsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "JournalsCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "JournalsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "JournalsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "JournalsPk3ResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LawFirmsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LawFirmsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LawFirmsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/lawFirms/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LawFirmsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LawFirmsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LawFirmsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LawFirmsResourceLinks", "exampleSetFlag" : false } ] }, "LawFirmsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LawFirmsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LawFirmsLegalCasesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LawFirmsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LawFirmsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LawFirmsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LawFirmsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (lawFirms)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "lawFirms" ] }, "id" : { "$ref" : "#/components/schemas/LawFirmsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "legalCases" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/lawFirms/{id}/relationships/legalCases" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/lawFirms/{id}/legalCases" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalParties" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/lawFirms/{id}/relationships/legalParties" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/lawFirms/{id}/legalParties" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LawFirmsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LawFirmsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/LawFirmsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/LawFirmsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/LawFirmsNameResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/LawFirmsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/LawFirmsActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LawFirmsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/LawFirmsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/LawFirmsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LawFirmsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LawFirmsLegalPartiesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LawFirmsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LawFirmsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LawFirmsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/LawFirmsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/LawFirmsNameResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/LawFirmsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/LawFirmsActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LawFirmsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/LawFirmsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/LawFirmsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LawFirmsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LawFirmsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LawFirmsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LawFirmsResourcePostAttributes", "exampleSetFlag" : false } ] }, "LawFirmsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/LawFirmsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/LawFirmsNameResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/LawFirmsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/LawFirmsActiveResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/LawFirmsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/LawFirmsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LawFirmsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (lawFirms)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "lawFirms" ] }, "id" : { "$ref" : "#/components/schemas/LawFirmsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LawFirmsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LawFirmsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LawFirmsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LawFirmsActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LawFirmsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LawFirmsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LawFirmsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LawFirmsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesLitigation_status_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LegalCasesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesCase_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalCasesCase_manager_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesSearch_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalCasesCase_statusResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesLegalPartyResourceAttribute" : { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalCasesInsurance_adjuster_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesDate_servedResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LegalCasesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalCasesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cases_sub_type_id" : { "$ref" : "#/components/schemas/LegalCasesCases_sub_type_idResourceAttribute", "exampleSetFlag" : false }, "cases_type_id" : { "$ref" : "#/components/schemas/LegalCasesCases_type_idResourceAttribute", "exampleSetFlag" : false }, "insurance_claim" : { "$ref" : "#/components/schemas/LegalCasesInsurance_claimResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/LegalCasesClosed_dateResourceAttribute", "exampleSetFlag" : false }, "law_firm_site_id" : { "$ref" : "#/components/schemas/LegalCasesLaw_firm_site_idResourceAttribute", "exampleSetFlag" : false }, "mediation_date" : { "$ref" : "#/components/schemas/LegalCasesMediation_dateResourceAttribute", "exampleSetFlag" : false }, "case_name" : { "$ref" : "#/components/schemas/LegalCasesCase_nameResourceAttribute", "exampleSetFlag" : false }, "court_case_number" : { "$ref" : "#/components/schemas/LegalCasesCourt_case_numberResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalCasesCreated_byResourceAttribute", "exampleSetFlag" : false }, "litigation_status_id" : { "$ref" : "#/components/schemas/LegalCasesLitigation_status_idResourceAttribute", "exampleSetFlag" : false }, "law_firm_id" : { "$ref" : "#/components/schemas/LegalCasesLaw_firm_idResourceAttribute", "exampleSetFlag" : false }, "case_manager_id" : { "$ref" : "#/components/schemas/LegalCasesCase_manager_idResourceAttribute", "exampleSetFlag" : false }, "legal_party_id" : { "$ref" : "#/components/schemas/LegalCasesLegal_party_idResourceAttribute", "exampleSetFlag" : false }, "date_served" : { "$ref" : "#/components/schemas/LegalCasesDate_servedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LegalCasesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "insurance_adjuster_id" : { "$ref" : "#/components/schemas/LegalCasesInsurance_adjuster_idResourceAttribute", "exampleSetFlag" : false }, "case_status" : { "$ref" : "#/components/schemas/LegalCasesCase_statusResourceAttribute", "exampleSetFlag" : false }, "matter_number" : { "$ref" : "#/components/schemas/LegalCasesMatter_numberResourceAttribute", "exampleSetFlag" : false }, "sued_by_type_id" : { "$ref" : "#/components/schemas/LegalCasesSued_by_type_idResourceAttribute", "exampleSetFlag" : false }, "date_sent_to_attorney" : { "$ref" : "#/components/schemas/LegalCasesDate_sent_to_attorneyResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LegalCasesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "trial_date" : { "$ref" : "#/components/schemas/LegalCasesTrial_dateResourceAttribute", "exampleSetFlag" : false }, "damage_agreed_date" : { "$ref" : "#/components/schemas/LegalCasesDamage_agreed_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/LegalCasesSearch_textResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesLegal_party_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesCases_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesCasesTypeResourceAttribute" : { "$ref" : "#/components/schemas/CasesTypesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalCasesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalCasesLaw_firm_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesLegalDamagesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LegalCasesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LegalCasesLaw_firm_site_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesMatter_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalCasesLawFirmResourceAttribute" : { "$ref" : "#/components/schemas/LawFirmsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalCasesCourt_case_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalCasesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (legalCases)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "legalCases" ] }, "id" : { "$ref" : "#/components/schemas/LegalCasesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesClaimDetailsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LegalCasesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LegalCasesSued_by_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LegalCasesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalCasesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalCasesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalCasesResourceLinks", "exampleSetFlag" : false } ] }, "LegalCasesDate_sent_to_attorneyResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LegalCasesCasesSubtypeResourceAttribute" : { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalCasesCases_sub_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cases_sub_type_id" : { "$ref" : "#/components/schemas/LegalCasesCases_sub_type_idResourceAttribute", "exampleSetFlag" : false }, "cases_type_id" : { "$ref" : "#/components/schemas/LegalCasesCases_type_idResourceAttribute", "exampleSetFlag" : false }, "insurance_claim" : { "$ref" : "#/components/schemas/LegalCasesInsurance_claimResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/LegalCasesClosed_dateResourceAttribute", "exampleSetFlag" : false }, "law_firm_site_id" : { "$ref" : "#/components/schemas/LegalCasesLaw_firm_site_idResourceAttribute", "exampleSetFlag" : false }, "mediation_date" : { "$ref" : "#/components/schemas/LegalCasesMediation_dateResourceAttribute", "exampleSetFlag" : false }, "case_name" : { "$ref" : "#/components/schemas/LegalCasesCase_nameResourceAttribute", "exampleSetFlag" : false }, "court_case_number" : { "$ref" : "#/components/schemas/LegalCasesCourt_case_numberResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalCasesCreated_byResourceAttribute", "exampleSetFlag" : false }, "litigation_status_id" : { "$ref" : "#/components/schemas/LegalCasesLitigation_status_idResourceAttribute", "exampleSetFlag" : false }, "law_firm_id" : { "$ref" : "#/components/schemas/LegalCasesLaw_firm_idResourceAttribute", "exampleSetFlag" : false }, "case_manager_id" : { "$ref" : "#/components/schemas/LegalCasesCase_manager_idResourceAttribute", "exampleSetFlag" : false }, "legal_party_id" : { "$ref" : "#/components/schemas/LegalCasesLegal_party_idResourceAttribute", "exampleSetFlag" : false }, "date_served" : { "$ref" : "#/components/schemas/LegalCasesDate_servedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LegalCasesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "insurance_adjuster_id" : { "$ref" : "#/components/schemas/LegalCasesInsurance_adjuster_idResourceAttribute", "exampleSetFlag" : false }, "case_status" : { "$ref" : "#/components/schemas/LegalCasesCase_statusResourceAttribute", "exampleSetFlag" : false }, "matter_number" : { "$ref" : "#/components/schemas/LegalCasesMatter_numberResourceAttribute", "exampleSetFlag" : false }, "sued_by_type_id" : { "$ref" : "#/components/schemas/LegalCasesSued_by_type_idResourceAttribute", "exampleSetFlag" : false }, "date_sent_to_attorney" : { "$ref" : "#/components/schemas/LegalCasesDate_sent_to_attorneyResourceAttribute", "exampleSetFlag" : false }, "trial_date" : { "$ref" : "#/components/schemas/LegalCasesTrial_dateResourceAttribute", "exampleSetFlag" : false }, "damage_agreed_date" : { "$ref" : "#/components/schemas/LegalCasesDamage_agreed_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/LegalCasesSearch_textResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesDamage_agreed_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LegalCasesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (legalCases)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "legalCases" ] }, "id" : { "$ref" : "#/components/schemas/LegalCasesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalCasesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalCasesResourcePostAttributes", "exampleSetFlag" : false } ] }, "LegalCasesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LegalCasesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LegalCasesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesLegalRisksResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LegalCasesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "casesSubtype" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/relationships/casesSubtype" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/casesSubtype" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CasesSubtypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "claimDetails" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/relationships/claimDetails" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/claimDetails" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "lawFirm" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/relationships/lawFirm" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/lawFirm" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LawFirmsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LawFirmsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "casesType" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/relationships/casesType" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/casesType" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CasesTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CasesTypesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalDamages" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/relationships/legalDamages" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/legalDamages" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalRisks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/relationships/legalRisks" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/legalRisks" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalParty" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/relationships/legalParty" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalCases/{id}/legalParty" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesInsurance_claimResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cases_sub_type_id" : { "$ref" : "#/components/schemas/LegalCasesCases_sub_type_idResourceAttribute", "exampleSetFlag" : false }, "insurance_claim" : { "$ref" : "#/components/schemas/LegalCasesInsurance_claimResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/LegalCasesClosed_dateResourceAttribute", "exampleSetFlag" : false }, "law_firm_site_id" : { "$ref" : "#/components/schemas/LegalCasesLaw_firm_site_idResourceAttribute", "exampleSetFlag" : false }, "case_name" : { "$ref" : "#/components/schemas/LegalCasesCase_nameResourceAttribute", "exampleSetFlag" : false }, "litigation_status_id" : { "$ref" : "#/components/schemas/LegalCasesLitigation_status_idResourceAttribute", "exampleSetFlag" : false }, "law_firm_id" : { "$ref" : "#/components/schemas/LegalCasesLaw_firm_idResourceAttribute", "exampleSetFlag" : false }, "date_served" : { "$ref" : "#/components/schemas/LegalCasesDate_servedResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LegalCasesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "insurance_adjuster_id" : { "$ref" : "#/components/schemas/LegalCasesInsurance_adjuster_idResourceAttribute", "exampleSetFlag" : false }, "matter_number" : { "$ref" : "#/components/schemas/LegalCasesMatter_numberResourceAttribute", "exampleSetFlag" : false }, "sued_by_type_id" : { "$ref" : "#/components/schemas/LegalCasesSued_by_type_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LegalCasesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "damage_agreed_date" : { "$ref" : "#/components/schemas/LegalCasesDamage_agreed_dateResourceAttribute", "exampleSetFlag" : false }, "cases_type_id" : { "$ref" : "#/components/schemas/LegalCasesCases_type_idResourceAttribute", "exampleSetFlag" : false }, "mediation_date" : { "$ref" : "#/components/schemas/LegalCasesMediation_dateResourceAttribute", "exampleSetFlag" : false }, "court_case_number" : { "$ref" : "#/components/schemas/LegalCasesCourt_case_numberResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalCasesCreated_byResourceAttribute", "exampleSetFlag" : false }, "case_manager_id" : { "$ref" : "#/components/schemas/LegalCasesCase_manager_idResourceAttribute", "exampleSetFlag" : false }, "legal_party_id" : { "$ref" : "#/components/schemas/LegalCasesLegal_party_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/LegalCasesCreated_onResourceAttribute", "exampleSetFlag" : false }, "case_status" : { "$ref" : "#/components/schemas/LegalCasesCase_statusResourceAttribute", "exampleSetFlag" : false }, "date_sent_to_attorney" : { "$ref" : "#/components/schemas/LegalCasesDate_sent_to_attorneyResourceAttribute", "exampleSetFlag" : false }, "trial_date" : { "$ref" : "#/components/schemas/LegalCasesTrial_dateResourceAttribute", "exampleSetFlag" : false }, "search_text" : { "$ref" : "#/components/schemas/LegalCasesSearch_textResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesClosed_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LegalCasesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalCasesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalCasesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalCasesTrial_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LegalCasesMediation_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LegalDamagesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalDamagesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LegalDamagesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LegalDamagesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalDamagesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LegalDamagesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/LegalDamagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/LegalDamagesCreated_onResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/LegalDamagesCase_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LegalDamagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalDamagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/LegalDamagesDamage_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/LegalDamagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/LegalDamagesCase_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalDamagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/LegalDamagesDamage_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalDamagesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalDamagesDamage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalDamagesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalDamages/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalDamages/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalCase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalDamages/{id}/relationships/legalCase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalDamages/{id}/legalCase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesLegalCaseResourceAttribute" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalDamagesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalDamagesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LegalDamagesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LegalDamagesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/LegalDamagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/LegalDamagesCase_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LegalDamagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalDamagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/LegalDamagesDamage_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (legalDamages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "legalDamages" ] }, "id" : { "$ref" : "#/components/schemas/LegalDamagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalDamagesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalDamagesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalDamagesResourceLinks", "exampleSetFlag" : false } ] }, "LegalDamagesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalDamagesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LegalDamagesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (legalDamages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "legalDamages" ] }, "id" : { "$ref" : "#/components/schemas/LegalDamagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalDamages/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalDamagesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalDamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalDamagesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalDamagesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalDamagesResourcePostAttributes", "exampleSetFlag" : false } ] }, "LegalDamagesCase_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalPartiesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (legalParties)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "legalParties" ] }, "id" : { "$ref" : "#/components/schemas/LegalPartiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "country" : { "$ref" : "#/components/schemas/LegalPartiesCountryResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/LegalPartiesCityResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/LegalPartiesStateidResourceAttribute", "exampleSetFlag" : false }, "law_firm_id" : { "$ref" : "#/components/schemas/LegalPartiesLaw_firm_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LegalPartiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "legal_party_type_id" : { "$ref" : "#/components/schemas/LegalPartiesLegal_party_type_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LegalPartiesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/LegalPartiesStateResourceAttribute", "exampleSetFlag" : false }, "fax" : { "$ref" : "#/components/schemas/LegalPartiesFaxResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/LegalPartiesFirst_nameResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/LegalPartiesEmailResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/LegalPartiesZipResourceAttribute", "exampleSetFlag" : false }, "address2" : { "$ref" : "#/components/schemas/LegalPartiesAddress2ResourceAttribute", "exampleSetFlag" : false }, "address1" : { "$ref" : "#/components/schemas/LegalPartiesAddress1ResourceAttribute", "exampleSetFlag" : false }, "mobile" : { "$ref" : "#/components/schemas/LegalPartiesMobileResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/LegalPartiesLast_nameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/LegalPartiesActiveResourceAttribute", "exampleSetFlag" : false }, "middle_name" : { "$ref" : "#/components/schemas/LegalPartiesMiddle_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalPartiesCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/LegalPartiesCountryidResourceAttribute", "exampleSetFlag" : false }, "phone" : { "$ref" : "#/components/schemas/LegalPartiesPhoneResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/LegalPartiesCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/LegalPartiesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/LegalPartiesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/LegalPartiesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "preferred_name" : { "$ref" : "#/components/schemas/LegalPartiesPreferred_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalPartiesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalPartiesResourcePostAttributes", "exampleSetFlag" : false } ] }, "LegalPartiesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalParties/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesLaw_firm_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalPartiesLast_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesPreferred_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesFaxResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesCountryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesPhoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesEmailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LegalPartiesAddress2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalPartiesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesAddress1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LegalPartiesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "legalCases" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalParties/{id}/relationships/legalCases" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalParties/{id}/legalCases" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "lawFirm" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalParties/{id}/relationships/lawFirm" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalParties/{id}/lawFirm" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LawFirmsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LawFirmsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalPartiesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalPartiesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "zip" : { "$ref" : "#/components/schemas/LegalPartiesZipResourceAttribute", "exampleSetFlag" : false }, "country" : { "$ref" : "#/components/schemas/LegalPartiesCountryResourceAttribute", "exampleSetFlag" : false }, "address2" : { "$ref" : "#/components/schemas/LegalPartiesAddress2ResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/LegalPartiesCityResourceAttribute", "exampleSetFlag" : false }, "address1" : { "$ref" : "#/components/schemas/LegalPartiesAddress1ResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/LegalPartiesStateidResourceAttribute", "exampleSetFlag" : false }, "mobile" : { "$ref" : "#/components/schemas/LegalPartiesMobileResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/LegalPartiesLast_nameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/LegalPartiesActiveResourceAttribute", "exampleSetFlag" : false }, "middle_name" : { "$ref" : "#/components/schemas/LegalPartiesMiddle_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalPartiesCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/LegalPartiesCountryidResourceAttribute", "exampleSetFlag" : false }, "law_firm_id" : { "$ref" : "#/components/schemas/LegalPartiesLaw_firm_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LegalPartiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "phone" : { "$ref" : "#/components/schemas/LegalPartiesPhoneResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/LegalPartiesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "legal_party_type_id" : { "$ref" : "#/components/schemas/LegalPartiesLegal_party_type_idResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/LegalPartiesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/LegalPartiesStateResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/LegalPartiesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "fax" : { "$ref" : "#/components/schemas/LegalPartiesFaxResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/LegalPartiesFirst_nameResourceAttribute", "exampleSetFlag" : false }, "preferred_name" : { "$ref" : "#/components/schemas/LegalPartiesPreferred_nameResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/LegalPartiesEmailResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LegalPartiesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LegalPartiesZipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalPartiesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalPartiesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalPartiesResourceLinks", "exampleSetFlag" : false } ] }, "LegalPartiesLegal_party_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalPartiesCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesLawFirmResourceAttribute" : { "$ref" : "#/components/schemas/LawFirmsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalPartiesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesFirst_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (legalParties)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "legalParties" ] }, "id" : { "$ref" : "#/components/schemas/LegalPartiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "country" : { "$ref" : "#/components/schemas/LegalPartiesCountryResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/LegalPartiesCityResourceAttribute", "exampleSetFlag" : false }, "stateid" : { "$ref" : "#/components/schemas/LegalPartiesStateidResourceAttribute", "exampleSetFlag" : false }, "law_firm_id" : { "$ref" : "#/components/schemas/LegalPartiesLaw_firm_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LegalPartiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "legal_party_type_id" : { "$ref" : "#/components/schemas/LegalPartiesLegal_party_type_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LegalPartiesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/LegalPartiesStateResourceAttribute", "exampleSetFlag" : false }, "fax" : { "$ref" : "#/components/schemas/LegalPartiesFaxResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/LegalPartiesFirst_nameResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/LegalPartiesEmailResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/LegalPartiesZipResourceAttribute", "exampleSetFlag" : false }, "address2" : { "$ref" : "#/components/schemas/LegalPartiesAddress2ResourceAttribute", "exampleSetFlag" : false }, "address1" : { "$ref" : "#/components/schemas/LegalPartiesAddress1ResourceAttribute", "exampleSetFlag" : false }, "mobile" : { "$ref" : "#/components/schemas/LegalPartiesMobileResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/LegalPartiesLast_nameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/LegalPartiesActiveResourceAttribute", "exampleSetFlag" : false }, "middle_name" : { "$ref" : "#/components/schemas/LegalPartiesMiddle_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalPartiesCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/LegalPartiesCountryidResourceAttribute", "exampleSetFlag" : false }, "phone" : { "$ref" : "#/components/schemas/LegalPartiesPhoneResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/LegalPartiesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/LegalPartiesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/LegalPartiesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "preferred_name" : { "$ref" : "#/components/schemas/LegalPartiesPreferred_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesMiddle_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesMobileResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalPartiesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LegalPartiesLegalCasesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LegalPartiesCountryidResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalPartiesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LegalPartiesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalPartiesStateidResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalPartiesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalPartiesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LegalPartiesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LegalPartiesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LegalRisksEstimateResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LegalRisksResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LegalRisksResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LegalRisksExpense_accrual_balanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "LegalRisksPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (legalRisks)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "legalRisks" ] }, "id" : { "$ref" : "#/components/schemas/LegalRisksIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksAccrual_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "LegalRisksLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalRisksSettlement_accrual_balanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "LegalRisksCmsRequestResourceAttribute" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalRisksResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "accrual_flag" : { "$ref" : "#/components/schemas/LegalRisksAccrual_flagResourceAttribute", "exampleSetFlag" : false }, "liability_age" : { "$ref" : "#/components/schemas/LegalRisksLiability_ageResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/LegalRisksActiveResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/LegalRisksVersion_numberResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalRisksCreated_byResourceAttribute", "exampleSetFlag" : false }, "accrual_amount" : { "$ref" : "#/components/schemas/LegalRisksAccrual_amountResourceAttribute", "exampleSetFlag" : false }, "expense_accrual_balance" : { "$ref" : "#/components/schemas/LegalRisksExpense_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "settlement_reserve" : { "$ref" : "#/components/schemas/LegalRisksSettlement_reserveResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LegalRisksLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "expense_reserve" : { "$ref" : "#/components/schemas/LegalRisksExpense_reserveResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/LegalRisksCreated_onResourceAttribute", "exampleSetFlag" : false }, "legal_risk_id" : { "$ref" : "#/components/schemas/LegalRisksLegal_risk_idResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/LegalRisksCase_idResourceAttribute", "exampleSetFlag" : false }, "estimate" : { "$ref" : "#/components/schemas/LegalRisksEstimateResourceAttribute", "exampleSetFlag" : false }, "lawsuit_demand_amount" : { "$ref" : "#/components/schemas/LegalRisksLawsuit_demand_amountResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LegalRisksLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/LegalRisksPeriod_idResourceAttribute", "exampleSetFlag" : false }, "settlement_accrual_balance" : { "$ref" : "#/components/schemas/LegalRisksSettlement_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/LegalRisksRequest_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalRisksPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalRisksResourcePostAttributes", "exampleSetFlag" : false } ] }, "LegalRisksPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LegalRisksPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalRisks/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalRisksResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksLiability_ageResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalRisksVersion_numberResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalRisksPeriod_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalRisksLegalCaseResourceAttribute" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalRisksExpense_reserveResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "LegalRisksActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LegalRisksIdResourceAttribute" : { "type" : "object", "properties" : { "legal_risk_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "version_number" : { "type" : "integer", "format" : "int32", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksLawsuit_demand_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "LegalRisksResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (legalRisks)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "legalRisks" ] }, "id" : { "$ref" : "#/components/schemas/LegalRisksIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "accrual_flag" : { "$ref" : "#/components/schemas/LegalRisksAccrual_flagResourceAttribute", "exampleSetFlag" : false }, "liability_age" : { "$ref" : "#/components/schemas/LegalRisksLiability_ageResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/LegalRisksActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalRisksCreated_byResourceAttribute", "exampleSetFlag" : false }, "accrual_amount" : { "$ref" : "#/components/schemas/LegalRisksAccrual_amountResourceAttribute", "exampleSetFlag" : false }, "expense_accrual_balance" : { "$ref" : "#/components/schemas/LegalRisksExpense_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "settlement_reserve" : { "$ref" : "#/components/schemas/LegalRisksSettlement_reserveResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LegalRisksLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "expense_reserve" : { "$ref" : "#/components/schemas/LegalRisksExpense_reserveResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/LegalRisksCase_idResourceAttribute", "exampleSetFlag" : false }, "estimate" : { "$ref" : "#/components/schemas/LegalRisksEstimateResourceAttribute", "exampleSetFlag" : false }, "lawsuit_demand_amount" : { "$ref" : "#/components/schemas/LegalRisksLawsuit_demand_amountResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LegalRisksLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/LegalRisksPeriod_idResourceAttribute", "exampleSetFlag" : false }, "settlement_accrual_balance" : { "$ref" : "#/components/schemas/LegalRisksSettlement_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/LegalRisksRequest_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalRisksResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalRisksResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LegalRisksResourceLinks", "exampleSetFlag" : false } ] }, "LegalRisksAccrual_flagResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LegalRisksCase_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalRisksCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LegalRisksLegal_risk_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalRisksCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LegalRisksResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "financialPeriod" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalRisks/{id}/relationships/financialPeriod" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalRisks/{id}/financialPeriod" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "legalCase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalRisks/{id}/relationships/legalCase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalRisks/{id}/legalCase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LegalCasesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsRequest" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalRisks/{id}/relationships/cmsRequest" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/legalRisks/{id}/cmsRequest" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LegalRisksResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LegalRisksResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LegalRisksSettlement_reserveResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "LegalRisksRequest_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LegalRisksFinancialPeriodResourceAttribute" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LegalRisksResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "accrual_flag" : { "$ref" : "#/components/schemas/LegalRisksAccrual_flagResourceAttribute", "exampleSetFlag" : false }, "liability_age" : { "$ref" : "#/components/schemas/LegalRisksLiability_ageResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/LegalRisksActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LegalRisksCreated_byResourceAttribute", "exampleSetFlag" : false }, "accrual_amount" : { "$ref" : "#/components/schemas/LegalRisksAccrual_amountResourceAttribute", "exampleSetFlag" : false }, "expense_accrual_balance" : { "$ref" : "#/components/schemas/LegalRisksExpense_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "settlement_reserve" : { "$ref" : "#/components/schemas/LegalRisksSettlement_reserveResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LegalRisksLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "expense_reserve" : { "$ref" : "#/components/schemas/LegalRisksExpense_reserveResourceAttribute", "exampleSetFlag" : false }, "case_id" : { "$ref" : "#/components/schemas/LegalRisksCase_idResourceAttribute", "exampleSetFlag" : false }, "estimate" : { "$ref" : "#/components/schemas/LegalRisksEstimateResourceAttribute", "exampleSetFlag" : false }, "lawsuit_demand_amount" : { "$ref" : "#/components/schemas/LegalRisksLawsuit_demand_amountResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/LegalRisksPeriod_idResourceAttribute", "exampleSetFlag" : false }, "settlement_accrual_balance" : { "$ref" : "#/components/schemas/LegalRisksSettlement_accrual_balanceResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/LegalRisksRequest_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "asset_district_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_district_idResourceAttribute", "exampleSetFlag" : false }, "loan_supgroup" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsLoan_supgroupResourceAttribute", "exampleSetFlag" : false }, "employee_name" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsEmployee_nameResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsVersion_numberResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_idResourceAttribute", "exampleSetFlag" : false }, "asset_district" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_districtResourceAttribute", "exampleSetFlag" : false }, "home_supgroup" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsHome_supgroupResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "home_district" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsHome_districtResourceAttribute", "exampleSetFlag" : false }, "asset_description" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_descriptionResourceAttribute", "exampleSetFlag" : false }, "asset_type" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_typeResourceAttribute", "exampleSetFlag" : false }, "tag_number" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsTag_numberResourceAttribute", "exampleSetFlag" : false }, "asset_supgroup" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_supgroupResourceAttribute", "exampleSetFlag" : false }, "loan_district_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsLoan_district_idResourceAttribute", "exampleSetFlag" : false }, "job_title" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsJob_titleResourceAttribute", "exampleSetFlag" : false }, "asset_place" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_placeResourceAttribute", "exampleSetFlag" : false }, "loan_district" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsLoan_districtResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsAsset_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LoanedEmployeeAssetsLoan_districtResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsAsset_descriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (loanedEmployeeAssets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "loanedEmployeeAssets" ] }, "id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsSerial_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsTag_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/loanedEmployeeAssets/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsHome_districtResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LoanedEmployeeAssetsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "home_district_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsHome_district_idResourceAttribute", "exampleSetFlag" : false }, "asset_district_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_district_idResourceAttribute", "exampleSetFlag" : false }, "loan_supgroup" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsLoan_supgroupResourceAttribute", "exampleSetFlag" : false }, "employee_name" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsEmployee_nameResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsVersion_numberResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_idResourceAttribute", "exampleSetFlag" : false }, "asset_district" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_districtResourceAttribute", "exampleSetFlag" : false }, "home_supgroup" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsHome_supgroupResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "home_district" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsHome_districtResourceAttribute", "exampleSetFlag" : false }, "asset_description" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_descriptionResourceAttribute", "exampleSetFlag" : false }, "asset_type" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_typeResourceAttribute", "exampleSetFlag" : false }, "tag_number" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsTag_numberResourceAttribute", "exampleSetFlag" : false }, "asset_supgroup" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_supgroupResourceAttribute", "exampleSetFlag" : false }, "loan_district_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsLoan_district_idResourceAttribute", "exampleSetFlag" : false }, "job_title" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsJob_titleResourceAttribute", "exampleSetFlag" : false }, "asset_place" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_placeResourceAttribute", "exampleSetFlag" : false }, "loan_district" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsLoan_districtResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsLoan_supgroupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (loanedEmployeeAssets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "loanedEmployeeAssets" ] }, "id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LoanedEmployeeAssetsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LoanedEmployeeAssetsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourcePostAttributes", "exampleSetFlag" : false } ] }, "LoanedEmployeeAssetsHome_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LoanedEmployeeAssetsEmployee_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsHome_supgroupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceLinks", "exampleSetFlag" : false } ] }, "LoanedEmployeeAssetsAsset_placeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsAsset_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsVersion_numberResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LoanedEmployeeAssetsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsJob_titleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsAssetResourceAttribute" : { "$ref" : "#/components/schemas/AssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LoanedEmployeeAssetsLoan_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LoanedEmployeeAssetsAsset_districtResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LoanedEmployeeAssetsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "asset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/loanedEmployeeAssets/{id}/relationships/asset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/loanedEmployeeAssets/{id}/asset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "asset_district_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_district_idResourceAttribute", "exampleSetFlag" : false }, "loan_supgroup" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsLoan_supgroupResourceAttribute", "exampleSetFlag" : false }, "employee_name" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsEmployee_nameResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsVersion_numberResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_idResourceAttribute", "exampleSetFlag" : false }, "asset_district" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_districtResourceAttribute", "exampleSetFlag" : false }, "home_supgroup" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsHome_supgroupResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "home_district" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsHome_districtResourceAttribute", "exampleSetFlag" : false }, "asset_description" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_descriptionResourceAttribute", "exampleSetFlag" : false }, "asset_type" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_typeResourceAttribute", "exampleSetFlag" : false }, "tag_number" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsTag_numberResourceAttribute", "exampleSetFlag" : false }, "asset_supgroup" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_supgroupResourceAttribute", "exampleSetFlag" : false }, "loan_district_id" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsLoan_district_idResourceAttribute", "exampleSetFlag" : false }, "job_title" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsJob_titleResourceAttribute", "exampleSetFlag" : false }, "asset_place" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsAsset_placeResourceAttribute", "exampleSetFlag" : false }, "loan_district" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsLoan_districtResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LoanedEmployeeAssetsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LoanedEmployeeAssetsAsset_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LoanedEmployeeAssetsAsset_supgroupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsHigh_profileResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateClosedSnapshotsFirstClosingActivityResourceAttribute" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "latest_activity_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsLatest_activity_idResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsClosed_dateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsCityResourceAttribute", "exampleSetFlag" : false }, "streetname" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsStreetnameResourceAttribute", "exampleSetFlag" : false }, "seqnum" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsSeqnumResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsCountyResourceAttribute", "exampleSetFlag" : false }, "emergency" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsEmergencyResourceAttribute", "exampleSetFlag" : false }, "project" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsProjectResourceAttribute", "exampleSetFlag" : false }, "initial_status_date" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsInitial_status_dateResourceAttribute", "exampleSetFlag" : false }, "past_due" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsPast_dueResourceAttribute", "exampleSetFlag" : false }, "high_profile_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsHigh_profile_idResourceAttribute", "exampleSetFlag" : false }, "client_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsClient_idResourceAttribute", "exampleSetFlag" : false }, "bucket_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsBucket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsExcavatorResourceAttribute", "exampleSetFlag" : false }, "added_by_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsAdded_by_idResourceAttribute", "exampleSetFlag" : false }, "utility_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsUtility_idResourceAttribute", "exampleSetFlag" : false }, "transmission_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsTransmission_idResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsStateResourceAttribute", "exampleSetFlag" : false }, "tickettype" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsTickettypeResourceAttribute", "exampleSetFlag" : false }, "legal_due_date" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsLegal_due_dateResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "call_date" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsCall_dateResourceAttribute", "exampleSetFlag" : false }, "street_number" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsStreet_numberResourceAttribute", "exampleSetFlag" : false }, "first_closing_activity_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsFirst_closing_activity_idResourceAttribute", "exampleSetFlag" : false }, "our_due_date" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsOur_due_dateResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsHigh_profileResourceAttribute", "exampleSetFlag" : false }, "open" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsOpenResourceAttribute", "exampleSetFlag" : false }, "parse_date" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsParse_dateResourceAttribute", "exampleSetFlag" : false }, "customer" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsCustomerResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsCall_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsActivitiesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LocateClosedSnapshotsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocateClosedSnapshotsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourcePostAttributes", "exampleSetFlag" : false } ] }, "LocateClosedSnapshotsLatestActivityResourceAttribute" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsProjectResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateClosedSnapshotsUtility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsOur_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsAdded_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsPast_dueResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateClosedSnapshotsTransmissionResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsSeqnumResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locateClosedSnapshots)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locateClosedSnapshots" ] }, "id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsEmergencyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateClosedSnapshotsBucketResourceAttribute" : { "$ref" : "#/components/schemas/BucketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsStreetnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsClient_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LocateClosedSnapshotsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsTransmissionBaseResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsCustomerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsBucket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsLegal_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsInitial_status_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsTransmissionDetailResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceLinks", "exampleSetFlag" : false } ] }, "LocateClosedSnapshotsHigh_profile_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsTermUtilityMapResourceAttribute" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsUtilityResourceAttribute" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsParse_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsTermResourceAttribute" : { "$ref" : "#/components/schemas/TermsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsOpenResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateClosedSnapshotsTransmissionExtraResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsTransmission_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsExcavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsTransmissionTextResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsStreet_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "latestActivity" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/latestActivity" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/latestActivity" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionExtra" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmissionExtra" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/transmissionExtra" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "termUtilityMap" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/termUtilityMap" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/termUtilityMap" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "utility" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/utility" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/utility" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmissionDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/transmissionDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionBase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmissionBase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/transmissionBase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "bucket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/bucket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/bucket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "projectTicket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/projectTicket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/projectTicket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionText" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmissionText" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/transmissionText" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmission" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/transmission" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/transmission" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "firstClosingActivity" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/firstClosingActivity" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/firstClosingActivity" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "activities" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/activities" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/activities" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "term" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/relationships/term" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateClosedSnapshots/{id}/term" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "project" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsProjectResourceAttribute", "exampleSetFlag" : false }, "past_due" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsPast_dueResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsHigh_profileResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsProjectTicketResourceAttribute" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateClosedSnapshotsClosed_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsFirst_closing_activity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateClosedSnapshotsTickettypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateClosedSnapshotsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "project" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsProjectResourceAttribute", "exampleSetFlag" : false }, "past_due" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsPast_dueResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsHigh_profileResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LocateClosedSnapshotsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locateClosedSnapshots)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locateClosedSnapshots" ] }, "id" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateClosedSnapshotsLatest_activity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "latest_activity_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsLatest_activity_idResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsClosed_dateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsCityResourceAttribute", "exampleSetFlag" : false }, "streetname" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsStreetnameResourceAttribute", "exampleSetFlag" : false }, "seqnum" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsSeqnumResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsCountyResourceAttribute", "exampleSetFlag" : false }, "emergency" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsEmergencyResourceAttribute", "exampleSetFlag" : false }, "project" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsProjectResourceAttribute", "exampleSetFlag" : false }, "initial_status_date" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsInitial_status_dateResourceAttribute", "exampleSetFlag" : false }, "past_due" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsPast_dueResourceAttribute", "exampleSetFlag" : false }, "high_profile_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsHigh_profile_idResourceAttribute", "exampleSetFlag" : false }, "client_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsClient_idResourceAttribute", "exampleSetFlag" : false }, "bucket_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsBucket_idResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsExcavatorResourceAttribute", "exampleSetFlag" : false }, "added_by_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsAdded_by_idResourceAttribute", "exampleSetFlag" : false }, "utility_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsUtility_idResourceAttribute", "exampleSetFlag" : false }, "transmission_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsTransmission_idResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsStateResourceAttribute", "exampleSetFlag" : false }, "tickettype" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsTickettypeResourceAttribute", "exampleSetFlag" : false }, "legal_due_date" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsLegal_due_dateResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "call_date" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsCall_dateResourceAttribute", "exampleSetFlag" : false }, "street_number" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsStreet_numberResourceAttribute", "exampleSetFlag" : false }, "first_closing_activity_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsFirst_closing_activity_idResourceAttribute", "exampleSetFlag" : false }, "our_due_date" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsOur_due_dateResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsHigh_profileResourceAttribute", "exampleSetFlag" : false }, "open" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsOpenResourceAttribute", "exampleSetFlag" : false }, "parse_date" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsParse_dateResourceAttribute", "exampleSetFlag" : false }, "customer" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsCustomerResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsBucketResourceAttribute" : { "$ref" : "#/components/schemas/BucketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LocateOpenSnapshotsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LocateOpenSnapshotsBucket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsStreetnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsStreet_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsInitial_status_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locateOpenSnapshots)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locateOpenSnapshots" ] }, "id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsCustomerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsTransmission_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "project" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsProjectResourceAttribute", "exampleSetFlag" : false }, "past_due" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsPast_dueResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsHigh_profileResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsTransmissionBaseResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsTransmissionDetailResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsProjectTicketResourceAttribute" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsTermResourceAttribute" : { "$ref" : "#/components/schemas/TermsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceLinks", "exampleSetFlag" : false } ] }, "LocateOpenSnapshotsLatestActivityResourceAttribute" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsClient_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsHigh_profileResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateOpenSnapshotsTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsLegal_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "project" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsProjectResourceAttribute", "exampleSetFlag" : false }, "past_due" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsPast_dueResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsHigh_profileResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsTransmissionTextResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsAdded_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocateOpenSnapshotsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourcePostAttributes", "exampleSetFlag" : false } ] }, "LocateOpenSnapshotsProjectResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateOpenSnapshotsFirstClosingActivityResourceAttribute" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsParse_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsActivitiesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LocateOpenSnapshotsUtility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsEmergencyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateOpenSnapshotsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsTransmissionResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsLatest_activity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsOur_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "latestActivity" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/latestActivity" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/latestActivity" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionExtra" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmissionExtra" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/transmissionExtra" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "termUtilityMap" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/termUtilityMap" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/termUtilityMap" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "utility" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/utility" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/utility" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmissionDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/transmissionDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionBase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmissionBase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/transmissionBase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "bucket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/bucket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/bucket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "projectTicket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/projectTicket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/projectTicket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionText" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmissionText" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/transmissionText" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmission" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/transmission" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/transmission" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "firstClosingActivity" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/firstClosingActivity" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/firstClosingActivity" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "activities" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/activities" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/activities" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "term" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/relationships/term" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locateOpenSnapshots/{id}/term" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsTermUtilityMapResourceAttribute" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsTickettypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsOpenResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateOpenSnapshotsHigh_profile_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locateOpenSnapshots)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locateOpenSnapshots" ] }, "id" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocateOpenSnapshotsTransmissionExtraResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsUtilityResourceAttribute" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocateOpenSnapshotsCall_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsPast_dueResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocateOpenSnapshotsFirst_closing_activity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsExcavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocateOpenSnapshotsCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsSeqnumResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocateOpenSnapshotsClosed_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatesClosed_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatesTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "closed_date" : { "$ref" : "#/components/schemas/LocatesClosed_dateResourceAttribute", "exampleSetFlag" : false }, "project" : { "$ref" : "#/components/schemas/LocatesProjectResourceAttribute", "exampleSetFlag" : false }, "initial_status_date" : { "$ref" : "#/components/schemas/LocatesInitial_status_dateResourceAttribute", "exampleSetFlag" : false }, "past_due" : { "$ref" : "#/components/schemas/LocatesPast_dueResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/LocatesHigh_profileResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesPast_dueResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocatesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "closed_date" : { "$ref" : "#/components/schemas/LocatesClosed_dateResourceAttribute", "exampleSetFlag" : false }, "project" : { "$ref" : "#/components/schemas/LocatesProjectResourceAttribute", "exampleSetFlag" : false }, "initial_status_date" : { "$ref" : "#/components/schemas/LocatesInitial_status_dateResourceAttribute", "exampleSetFlag" : false }, "past_due" : { "$ref" : "#/components/schemas/LocatesPast_dueResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/LocatesHigh_profileResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesInitial_status_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatesFirst_closing_activity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesLatestActivityResourceAttribute" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesUtility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesTransmissionBaseResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesProjectTicketResourceAttribute" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocatesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatesResourcePostAttributes", "exampleSetFlag" : false } ] }, "LocatesHigh_profileResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocatesTermUtilityMapResourceAttribute" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesAdded_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesTransmissionDetailResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesTransmissionExtraResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatesResourceLinks", "exampleSetFlag" : false } ] }, "LocatesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LocatesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locates" ] }, "id" : { "$ref" : "#/components/schemas/LocatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesProjectResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocatesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "latest_activity_id" : { "$ref" : "#/components/schemas/LocatesLatest_activity_idResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/LocatesClosed_dateResourceAttribute", "exampleSetFlag" : false }, "seqnum" : { "$ref" : "#/components/schemas/LocatesSeqnumResourceAttribute", "exampleSetFlag" : false }, "legal_due_date" : { "$ref" : "#/components/schemas/LocatesLegal_due_dateResourceAttribute", "exampleSetFlag" : false }, "project" : { "$ref" : "#/components/schemas/LocatesProjectResourceAttribute", "exampleSetFlag" : false }, "initial_status_date" : { "$ref" : "#/components/schemas/LocatesInitial_status_dateResourceAttribute", "exampleSetFlag" : false }, "past_due" : { "$ref" : "#/components/schemas/LocatesPast_dueResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/LocatesTicket_idResourceAttribute", "exampleSetFlag" : false }, "high_profile_id" : { "$ref" : "#/components/schemas/LocatesHigh_profile_idResourceAttribute", "exampleSetFlag" : false }, "client_id" : { "$ref" : "#/components/schemas/LocatesClient_idResourceAttribute", "exampleSetFlag" : false }, "bucket_id" : { "$ref" : "#/components/schemas/LocatesBucket_idResourceAttribute", "exampleSetFlag" : false }, "added_by_id" : { "$ref" : "#/components/schemas/LocatesAdded_by_idResourceAttribute", "exampleSetFlag" : false }, "utility_id" : { "$ref" : "#/components/schemas/LocatesUtility_idResourceAttribute", "exampleSetFlag" : false }, "first_closing_activity_id" : { "$ref" : "#/components/schemas/LocatesFirst_closing_activity_idResourceAttribute", "exampleSetFlag" : false }, "transmission_id" : { "$ref" : "#/components/schemas/LocatesTransmission_idResourceAttribute", "exampleSetFlag" : false }, "our_due_date" : { "$ref" : "#/components/schemas/LocatesOur_due_dateResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/LocatesHigh_profileResourceAttribute", "exampleSetFlag" : false }, "open" : { "$ref" : "#/components/schemas/LocatesOpenResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locates" ] }, "id" : { "$ref" : "#/components/schemas/LocatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesSeqnumResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesTransmission_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "latestActivity" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/latestActivity" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/latestActivity" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionExtra" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/transmissionExtra" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/transmissionExtra" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "termUtilityMap" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/termUtilityMap" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/termUtilityMap" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "utility" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/utility" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/utility" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/transmissionDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/transmissionDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionBase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/transmissionBase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/transmissionBase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "bucket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/bucket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/bucket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "projectTicket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/projectTicket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/projectTicket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionText" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/transmissionText" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/transmissionText" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmission" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/transmission" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/transmission" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "firstClosingActivity" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/firstClosingActivity" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/firstClosingActivity" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "activities" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/activities" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/activities" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "term" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/relationships/term" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}/term" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesOur_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatesFirstClosingActivityResourceAttribute" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesHigh_profile_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesTransmissionResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesBucket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesTermResourceAttribute" : { "$ref" : "#/components/schemas/TermsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesActivitiesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LocatesOpenResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "LocatesTransmissionTextResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocatesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesLegal_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LocatesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LocatesBucketResourceAttribute" : { "$ref" : "#/components/schemas/BucketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesLatest_activity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatesUtilityResourceAttribute" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/locates/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatesClient_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocationsMobileResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "country" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/relationships/country" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/country" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "districtLocations" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/relationships/districtLocations" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/districtLocations" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "assets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/relationships/assets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/assets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "districts" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/relationships/districts" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/districts" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "state" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/relationships/state" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}/state" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocationsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocationsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocationsResourcePostRelationships", "exampleSetFlag" : false } ] }, "LocationsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "country" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsDistrictLocationsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LocationsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "notes" : { "$ref" : "#/components/schemas/LocationsNotesResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/LocationsCityResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/LocationsLatitudeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LocationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LocationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state_id" : { "$ref" : "#/components/schemas/LocationsState_idResourceAttribute", "exampleSetFlag" : false }, "fax" : { "$ref" : "#/components/schemas/LocationsFaxResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/LocationsEmailResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/LocationsLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/LocationsZipResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/LocationsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "contact_name" : { "$ref" : "#/components/schemas/LocationsContact_nameResourceAttribute", "exampleSetFlag" : false }, "address2" : { "$ref" : "#/components/schemas/LocationsAddress2ResourceAttribute", "exampleSetFlag" : false }, "address1" : { "$ref" : "#/components/schemas/LocationsAddress1ResourceAttribute", "exampleSetFlag" : false }, "mobile" : { "$ref" : "#/components/schemas/LocationsMobileResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LocationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "location_type_id" : { "$ref" : "#/components/schemas/LocationsLocation_type_idResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/LocationsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "phone" : { "$ref" : "#/components/schemas/LocationsPhoneResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/LocationsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/LocationsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/LocationsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/LocationsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/LocationsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/LocationsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/LocationsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "country_id" : { "$ref" : "#/components/schemas/LocationsCountry_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LocationsStateResourceAttribute" : { "$ref" : "#/components/schemas/StatesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocationsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LocationsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locations/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocationsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocationsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocationsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocationsResourceLinks", "exampleSetFlag" : false } ] }, "LocationsFaxResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LocationsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locations" ] }, "id" : { "$ref" : "#/components/schemas/LocationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LocationsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LocationsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "notes" : { "$ref" : "#/components/schemas/LocationsNotesResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/LocationsCityResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/LocationsLatitudeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LocationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LocationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state_id" : { "$ref" : "#/components/schemas/LocationsState_idResourceAttribute", "exampleSetFlag" : false }, "fax" : { "$ref" : "#/components/schemas/LocationsFaxResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/LocationsEmailResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/LocationsLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/LocationsZipResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/LocationsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "contact_name" : { "$ref" : "#/components/schemas/LocationsContact_nameResourceAttribute", "exampleSetFlag" : false }, "address2" : { "$ref" : "#/components/schemas/LocationsAddress2ResourceAttribute", "exampleSetFlag" : false }, "address1" : { "$ref" : "#/components/schemas/LocationsAddress1ResourceAttribute", "exampleSetFlag" : false }, "mobile" : { "$ref" : "#/components/schemas/LocationsMobileResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LocationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "location_type_id" : { "$ref" : "#/components/schemas/LocationsLocation_type_idResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/LocationsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "phone" : { "$ref" : "#/components/schemas/LocationsPhoneResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/LocationsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/LocationsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/LocationsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/LocationsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/LocationsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/LocationsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/LocationsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/LocationsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "country_id" : { "$ref" : "#/components/schemas/LocationsCountry_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsPhoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsLongitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "LocationsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locations" ] }, "id" : { "$ref" : "#/components/schemas/LocationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocationsDistrictsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LocationsAddress1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsEmailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsZipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsCountryResourceAttribute" : { "$ref" : "#/components/schemas/CountriesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocationsState_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocationsAddress2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocationsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "notes" : { "$ref" : "#/components/schemas/LocationsNotesResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/LocationsCityResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/LocationsLatitudeResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LocationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "state_id" : { "$ref" : "#/components/schemas/LocationsState_idResourceAttribute", "exampleSetFlag" : false }, "fax" : { "$ref" : "#/components/schemas/LocationsFaxResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/LocationsEmailResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/LocationsLongitudeResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/LocationsZipResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/LocationsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "contact_name" : { "$ref" : "#/components/schemas/LocationsContact_nameResourceAttribute", "exampleSetFlag" : false }, "address2" : { "$ref" : "#/components/schemas/LocationsAddress2ResourceAttribute", "exampleSetFlag" : false }, "address1" : { "$ref" : "#/components/schemas/LocationsAddress1ResourceAttribute", "exampleSetFlag" : false }, "mobile" : { "$ref" : "#/components/schemas/LocationsMobileResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LocationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "location_type_id" : { "$ref" : "#/components/schemas/LocationsLocation_type_idResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/LocationsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "phone" : { "$ref" : "#/components/schemas/LocationsPhoneResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/LocationsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/LocationsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/LocationsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/LocationsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/LocationsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/LocationsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/LocationsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "country_id" : { "$ref" : "#/components/schemas/LocationsCountry_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LocationsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LocationsLatitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "LocationsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "country" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsLocation_type_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocationsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocationsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocationsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocationsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsContact_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocationsAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "LocationsCountry_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocationsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LocatorCheckinsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locatorCheckins/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "checkin_action" : { "$ref" : "#/components/schemas/LocatorCheckinsCheckin_actionResourceAttribute", "exampleSetFlag" : false }, "reviewed_by" : { "$ref" : "#/components/schemas/LocatorCheckinsReviewed_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/LocatorCheckinsNotesResourceAttribute", "exampleSetFlag" : false }, "asset_version" : { "$ref" : "#/components/schemas/LocatorCheckinsAsset_versionResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/LocatorCheckinsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/LocatorCheckinsAsset_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LocatorCheckinsCreated_byResourceAttribute", "exampleSetFlag" : false }, "usic_tag" : { "$ref" : "#/components/schemas/LocatorCheckinsUsic_tagResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LocatorCheckinsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/LocatorCheckinsCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LocatorCheckinsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "reviewed_on" : { "$ref" : "#/components/schemas/LocatorCheckinsReviewed_onResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/LocatorCheckinsEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsCheckin_actionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatorCheckinsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatorCheckinsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatorCheckinsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatorCheckinsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatorCheckinsResourceLinks", "exampleSetFlag" : false } ] }, "LocatorCheckinsReviewed_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LocatorCheckinsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locatorCheckins)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locatorCheckins" ] }, "id" : { "$ref" : "#/components/schemas/LocatorCheckinsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LocatorCheckinsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatorCheckinsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatorCheckinsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "asset" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsAsset_versionResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatorCheckinsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "usic_tag" : { "$ref" : "#/components/schemas/LocatorCheckinsUsic_tagResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LocatorCheckinsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "checkin_action" : { "$ref" : "#/components/schemas/LocatorCheckinsCheckin_actionResourceAttribute", "exampleSetFlag" : false }, "reviewed_by" : { "$ref" : "#/components/schemas/LocatorCheckinsReviewed_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/LocatorCheckinsNotesResourceAttribute", "exampleSetFlag" : false }, "asset_version" : { "$ref" : "#/components/schemas/LocatorCheckinsAsset_versionResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/LocatorCheckinsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LocatorCheckinsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/LocatorCheckinsAsset_idResourceAttribute", "exampleSetFlag" : false }, "reviewed_on" : { "$ref" : "#/components/schemas/LocatorCheckinsReviewed_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LocatorCheckinsCreated_byResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/LocatorCheckinsEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locatorCheckins/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locatorCheckins/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locatorCheckins/{id}/relationships/asset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/locatorCheckins/{id}/asset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsAsset_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatorCheckinsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "LocatorCheckinsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LocatorCheckinsSerial_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatorCheckinsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatorCheckinsReviewed_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatorCheckinsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "asset" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsUsic_tagResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatorCheckinsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LocatorCheckinsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatorCheckinsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LocatorCheckinsResourcePostRelationships", "exampleSetFlag" : false } ] }, "LocatorCheckinsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LocatorCheckinsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatorCheckinsEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LocatorCheckinsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LocatorCheckinsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LocatorCheckinsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (locatorCheckins)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "locatorCheckins" ] }, "id" : { "$ref" : "#/components/schemas/LocatorCheckinsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "usic_tag" : { "$ref" : "#/components/schemas/LocatorCheckinsUsic_tagResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/LocatorCheckinsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "checkin_action" : { "$ref" : "#/components/schemas/LocatorCheckinsCheckin_actionResourceAttribute", "exampleSetFlag" : false }, "reviewed_by" : { "$ref" : "#/components/schemas/LocatorCheckinsReviewed_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/LocatorCheckinsNotesResourceAttribute", "exampleSetFlag" : false }, "asset_version" : { "$ref" : "#/components/schemas/LocatorCheckinsAsset_versionResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/LocatorCheckinsSerial_numberResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/LocatorCheckinsAsset_idResourceAttribute", "exampleSetFlag" : false }, "reviewed_on" : { "$ref" : "#/components/schemas/LocatorCheckinsReviewed_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LocatorCheckinsCreated_byResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/LocatorCheckinsEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LocatorCheckinsAssetResourceAttribute" : { "$ref" : "#/components/schemas/AssetsResourceReference", "nullable" : false, "exampleSetFlag" : false }, "LocatorCheckinsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatorCheckinsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LogosPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LogosResourcePostAttributes", "exampleSetFlag" : false } ] }, "LogosCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LogosResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (logos)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "logos" ] }, "id" : { "$ref" : "#/components/schemas/LogosIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LogosResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LogosResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "LogosLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LogosResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/LogosResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "LogosResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/LogosLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "company_image" : { "$ref" : "#/components/schemas/LogosCompany_imageResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/LogosEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LogosLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/LogosLabelResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/LogosCustomer_account_idResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/LogosEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LogosCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LogosResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "LogosCompany_imageResourceAttribute" : { "type" : "string", "format" : "byte", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LogosResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LogosResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LogosCustomer_account_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LogosPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/LogosPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "LogosPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (logos)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "logos" ] }, "id" : { "$ref" : "#/components/schemas/LogosIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LogosPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/LogosResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LogosResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/LogosResourceLinks", "exampleSetFlag" : false } ] }, "LogosLabelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LogosResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/LogosLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "company_image" : { "$ref" : "#/components/schemas/LogosCompany_imageResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/LogosEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/LogosLabelResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/LogosCustomer_account_idResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/LogosEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LogosCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "LogosResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/LogosLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "company_image" : { "$ref" : "#/components/schemas/LogosCompany_imageResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/LogosCreated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/LogosEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/LogosLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/LogosLabelResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/LogosCustomer_account_idResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/LogosEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/LogosCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LogosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "LogosEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "LogosResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/logos/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MdmDevicesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (mdmDevices)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "mdmDevices" ] }, "id" : { "$ref" : "#/components/schemas/MdmDevicesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MdmDevicesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "MdmDevicesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/MdmDevicesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MdmDevicesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MdmDevicesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MdmDevicesResourceLinks", "exampleSetFlag" : false } ] }, "MdmDevicesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/MdmDevicesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesDistrictResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (mdmDevices)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "mdmDevices" ] }, "id" : { "$ref" : "#/components/schemas/MdmDevicesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/mdmDevices/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/MdmDevicesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MdmDevicesResourcePostAttributes", "exampleSetFlag" : false } ] }, "MdmDevicesDevice_groupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesSerial_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/MdmDevicesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "MdmDevicesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "MdmDevicesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "iccid" : { "$ref" : "#/components/schemas/MdmDevicesIccidResourceAttribute", "exampleSetFlag" : false }, "device_name" : { "$ref" : "#/components/schemas/MdmDevicesDevice_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/MdmDevicesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "device_group" : { "$ref" : "#/components/schemas/MdmDevicesDevice_groupResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/MdmDevicesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/MdmDevicesDistrictResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/MdmDevicesSerial_numberResourceAttribute", "exampleSetFlag" : false }, "phone_number" : { "$ref" : "#/components/schemas/MdmDevicesPhone_numberResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/MdmDevicesModelResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/MdmDevicesCreated_byResourceAttribute", "exampleSetFlag" : false }, "username" : { "$ref" : "#/components/schemas/MdmDevicesUsernameResourceAttribute", "exampleSetFlag" : false }, "network" : { "$ref" : "#/components/schemas/MdmDevicesNetworkResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesModelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "device_group" : { "$ref" : "#/components/schemas/MdmDevicesDevice_groupResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/MdmDevicesSerial_numberResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/MdmDevicesCreated_byResourceAttribute", "exampleSetFlag" : false }, "network" : { "$ref" : "#/components/schemas/MdmDevicesNetworkResourceAttribute", "exampleSetFlag" : false }, "iccid" : { "$ref" : "#/components/schemas/MdmDevicesIccidResourceAttribute", "exampleSetFlag" : false }, "device_name" : { "$ref" : "#/components/schemas/MdmDevicesDevice_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/MdmDevicesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/MdmDevicesCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/MdmDevicesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/MdmDevicesDistrictResourceAttribute", "exampleSetFlag" : false }, "phone_number" : { "$ref" : "#/components/schemas/MdmDevicesPhone_numberResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/MdmDevicesModelResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/MdmDevicesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "username" : { "$ref" : "#/components/schemas/MdmDevicesUsernameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "MdmDevicesNetworkResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MdmDevicesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "MdmDevicesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/MdmDevicesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesUsernameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/MdmDevicesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MdmDevicesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/mdmDevices/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/mdmDevices/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "MdmDevicesEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MdmDevicesDevice_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesIccidResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesPhone_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MdmDevicesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "device_group" : { "$ref" : "#/components/schemas/MdmDevicesDevice_groupResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/MdmDevicesSerial_numberResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/MdmDevicesCreated_byResourceAttribute", "exampleSetFlag" : false }, "network" : { "$ref" : "#/components/schemas/MdmDevicesNetworkResourceAttribute", "exampleSetFlag" : false }, "iccid" : { "$ref" : "#/components/schemas/MdmDevicesIccidResourceAttribute", "exampleSetFlag" : false }, "device_name" : { "$ref" : "#/components/schemas/MdmDevicesDevice_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/MdmDevicesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/MdmDevicesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/MdmDevicesDistrictResourceAttribute", "exampleSetFlag" : false }, "phone_number" : { "$ref" : "#/components/schemas/MdmDevicesPhone_numberResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/MdmDevicesModelResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/MdmDevicesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "username" : { "$ref" : "#/components/schemas/MdmDevicesUsernameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/MessagesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "MessagesSubjectResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/MessagesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "subject" : { "$ref" : "#/components/schemas/MessagesSubjectResourceAttribute", "exampleSetFlag" : false }, "unreadCount" : { "$ref" : "#/components/schemas/MessagesUnreadCountResourceAttribute", "exampleSetFlag" : false }, "require_acknowledgement" : { "$ref" : "#/components/schemas/MessagesRequire_acknowledgementResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/MessagesMessageResourceAttribute", "exampleSetFlag" : false }, "readCount" : { "$ref" : "#/components/schemas/MessagesReadCountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/MessagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "sentCount" : { "$ref" : "#/components/schemas/MessagesSentCountResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/MessagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "message_preview" : { "$ref" : "#/components/schemas/MessagesMessage_previewResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/MessagesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "application" : { "$ref" : "#/components/schemas/MessagesApplicationResourceAttribute", "exampleSetFlag" : false }, "acknowledgedCount" : { "$ref" : "#/components/schemas/MessagesAcknowledgedCountResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/MessagesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/MessagesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/MessagesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/MessagesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/MessagesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/MessagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/MessagesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesMessage_previewResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/MessagesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesResourcePostRelationships", "exampleSetFlag" : false } ] }, "MessagesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesReadCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesAcknowledgedCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "MessagesEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "MessagesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesMessageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesSentCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesUnreadCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/MessagesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "subject" : { "$ref" : "#/components/schemas/MessagesSubjectResourceAttribute", "exampleSetFlag" : false }, "unreadCount" : { "$ref" : "#/components/schemas/MessagesUnreadCountResourceAttribute", "exampleSetFlag" : false }, "require_acknowledgement" : { "$ref" : "#/components/schemas/MessagesRequire_acknowledgementResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/MessagesMessageResourceAttribute", "exampleSetFlag" : false }, "readCount" : { "$ref" : "#/components/schemas/MessagesReadCountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/MessagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "sentCount" : { "$ref" : "#/components/schemas/MessagesSentCountResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/MessagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "message_preview" : { "$ref" : "#/components/schemas/MessagesMessage_previewResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/MessagesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "application" : { "$ref" : "#/components/schemas/MessagesApplicationResourceAttribute", "exampleSetFlag" : false }, "acknowledgedCount" : { "$ref" : "#/components/schemas/MessagesAcknowledgedCountResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/MessagesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/MessagesCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/MessagesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/MessagesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/MessagesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/MessagesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/MessagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/MessagesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeeMessages" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/MessagesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "subject" : { "$ref" : "#/components/schemas/MessagesSubjectResourceAttribute", "exampleSetFlag" : false }, "unreadCount" : { "$ref" : "#/components/schemas/MessagesUnreadCountResourceAttribute", "exampleSetFlag" : false }, "require_acknowledgement" : { "$ref" : "#/components/schemas/MessagesRequire_acknowledgementResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/MessagesMessageResourceAttribute", "exampleSetFlag" : false }, "readCount" : { "$ref" : "#/components/schemas/MessagesReadCountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/MessagesCreated_byResourceAttribute", "exampleSetFlag" : false }, "sentCount" : { "$ref" : "#/components/schemas/MessagesSentCountResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/MessagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "message_preview" : { "$ref" : "#/components/schemas/MessagesMessage_previewResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/MessagesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "application" : { "$ref" : "#/components/schemas/MessagesApplicationResourceAttribute", "exampleSetFlag" : false }, "acknowledgedCount" : { "$ref" : "#/components/schemas/MessagesAcknowledgedCountResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/MessagesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/MessagesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/MessagesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/MessagesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/MessagesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/MessagesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesEmployeeMessagesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "MessagesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/messages/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesResourceLinks", "exampleSetFlag" : false } ] }, "MessagesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/MessagesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "MessagesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "MessagesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "MessagesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (messages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "messages" ] }, "id" : { "$ref" : "#/components/schemas/MessagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesRequire_acknowledgementResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "MessagesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "MessagesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (messages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "messages" ] }, "id" : { "$ref" : "#/components/schemas/MessagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesApplicationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeeMessages" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/messages/{id}/relationships/employeeMessages" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/messages/{id}/employeeMessages" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/messages/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/messages/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeeMessages" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesWithCountsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/MessagesWithCountsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesWithCountsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesWithCountsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/MessagesWithCountsResourceLinks", "exampleSetFlag" : false } ] }, "MessagesWithCountsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/MessagesWithCountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/MessagesWithCountsPostResourceReference", "exampleSetFlag" : false } ] }, "MessagesWithCountsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "MessagesWithCountsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsReadCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesWithCountsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "MessagesWithCountsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesWithCountsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/MessagesWithCountsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesWithCountsUnreadCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesWithCountsSubjectResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/MessagesWithCountsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "subject" : { "$ref" : "#/components/schemas/MessagesWithCountsSubjectResourceAttribute", "exampleSetFlag" : false }, "unreadCount" : { "$ref" : "#/components/schemas/MessagesWithCountsUnreadCountResourceAttribute", "exampleSetFlag" : false }, "require_acknowledgement" : { "$ref" : "#/components/schemas/MessagesWithCountsRequire_acknowledgementResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/MessagesWithCountsMessageResourceAttribute", "exampleSetFlag" : false }, "readCount" : { "$ref" : "#/components/schemas/MessagesWithCountsReadCountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/MessagesWithCountsCreated_byResourceAttribute", "exampleSetFlag" : false }, "sentCount" : { "$ref" : "#/components/schemas/MessagesWithCountsSentCountResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/MessagesWithCountsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "message_preview" : { "$ref" : "#/components/schemas/MessagesWithCountsMessage_previewResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/MessagesWithCountsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "application" : { "$ref" : "#/components/schemas/MessagesWithCountsApplicationResourceAttribute", "exampleSetFlag" : false }, "acknowledgedCount" : { "$ref" : "#/components/schemas/MessagesWithCountsAcknowledgedCountResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/MessagesWithCountsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/MessagesWithCountsCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/MessagesWithCountsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/MessagesWithCountsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/MessagesWithCountsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/MessagesWithCountsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/MessagesWithCountsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/MessagesWithCountsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "MessagesWithCountsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsMessage_previewResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsApplicationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsAcknowledgedCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesWithCountsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (messagesWithCounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "messagesWithCounts" ] }, "id" : { "$ref" : "#/components/schemas/MessagesWithCountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsSentCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "MessagesWithCountsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (messagesWithCounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "messagesWithCounts" ] }, "id" : { "$ref" : "#/components/schemas/MessagesWithCountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/messagesWithCounts/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/messagesWithCounts/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsMessageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "MessagesWithCountsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "MessagesWithCountsRequire_acknowledgementResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "MessagesWithCountsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "MessagesWithCountsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/messagesWithCounts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "MessagesWithCountsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "MessagesWithCountsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "MessagesWithCountsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesOperating_systemResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesSerial_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesDisconnect_reasonResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "NetmotionDevicesLocality_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesLast_disconnectResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "NetmotionDevicesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "NetmotionDevicesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "mobility_version" : { "$ref" : "#/components/schemas/NetmotionDevicesMobility_versionResourceAttribute", "exampleSetFlag" : false }, "locality_version" : { "$ref" : "#/components/schemas/NetmotionDevicesLocality_versionResourceAttribute", "exampleSetFlag" : false }, "device_group" : { "$ref" : "#/components/schemas/NetmotionDevicesDevice_groupResourceAttribute", "exampleSetFlag" : false }, "registered" : { "$ref" : "#/components/schemas/NetmotionDevicesRegisteredResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/NetmotionDevicesSerial_numberResourceAttribute", "exampleSetFlag" : false }, "asset_id" : { "$ref" : "#/components/schemas/NetmotionDevicesAsset_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/NetmotionDevicesCreated_byResourceAttribute", "exampleSetFlag" : false }, "asset_category" : { "$ref" : "#/components/schemas/NetmotionDevicesAsset_categoryResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/NetmotionDevicesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_user" : { "$ref" : "#/components/schemas/NetmotionDevicesLast_userResourceAttribute", "exampleSetFlag" : false }, "last_disconnect" : { "$ref" : "#/components/schemas/NetmotionDevicesLast_disconnectResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/NetmotionDevicesCreated_onResourceAttribute", "exampleSetFlag" : false }, "operating_system" : { "$ref" : "#/components/schemas/NetmotionDevicesOperating_systemResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/NetmotionDevicesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "disconnect_reason" : { "$ref" : "#/components/schemas/NetmotionDevicesDisconnect_reasonResourceAttribute", "exampleSetFlag" : false }, "last_connect" : { "$ref" : "#/components/schemas/NetmotionDevicesLast_connectResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesMobility_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "NetmotionDevicesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "NetmotionDevicesAssetResourceAttribute" : { "$ref" : "#/components/schemas/AssetsResourceReference", "nullable" : false, "exampleSetFlag" : false }, "NetmotionDevicesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (netmotionDevices)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "netmotionDevices" ] }, "id" : { "$ref" : "#/components/schemas/NetmotionDevicesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/NetmotionDevicesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesLast_connectResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "NetmotionDevicesLast_userResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/NetmotionDevicesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/NetmotionDevicesPostResourceReference", "exampleSetFlag" : false } ] }, "NetmotionDevicesAsset_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "NetmotionDevicesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/NetmotionDevicesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/NetmotionDevicesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/NetmotionDevicesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/NetmotionDevicesResourceLinks", "exampleSetFlag" : false } ] }, "NetmotionDevicesAsset_categoryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/netmotionDevices/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/NetmotionDevicesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (netmotionDevices)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "netmotionDevices" ] }, "id" : { "$ref" : "#/components/schemas/NetmotionDevicesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesDevice_groupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NetmotionDevicesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "asset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/netmotionDevices/{id}/relationships/asset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/netmotionDevices/{id}/asset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "NetmotionDevicesRegisteredResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "NotesEntered_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "NotesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/NotesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NotesWhenenteredResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NotesWhenpostedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NotesEntity_kindResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NotesActivity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "NotesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/NotesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "NotesTypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NotesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/NotesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NotesNote_textResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "NotesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "entity_kind" : { "$ref" : "#/components/schemas/NotesEntity_kindResourceAttribute", "exampleSetFlag" : false }, "entered_by_id" : { "$ref" : "#/components/schemas/NotesEntered_by_idResourceAttribute", "exampleSetFlag" : false }, "excavator_note" : { "$ref" : "#/components/schemas/NotesExcavator_noteResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/NotesActivity_idResourceAttribute", "exampleSetFlag" : false }, "entity_id" : { "$ref" : "#/components/schemas/NotesEntity_idResourceAttribute", "exampleSetFlag" : false }, "whenposted" : { "$ref" : "#/components/schemas/NotesWhenpostedResourceAttribute", "exampleSetFlag" : false }, "type" : { "$ref" : "#/components/schemas/NotesTypeResourceAttribute", "exampleSetFlag" : false }, "note_text" : { "$ref" : "#/components/schemas/NotesNote_textResourceAttribute", "exampleSetFlag" : false }, "whenentered" : { "$ref" : "#/components/schemas/NotesWhenenteredResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NotesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/NotesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "NotesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (notes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "notes" ] }, "id" : { "$ref" : "#/components/schemas/NotesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NotesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/NotesPostResourceReference", "exampleSetFlag" : false } ] }, "NotesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/NotesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NotesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/NotesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NotesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "NotesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (notes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "notes" ] }, "id" : { "$ref" : "#/components/schemas/NotesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NotesExcavator_noteResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "NotesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/notes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "NotesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/NotesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/NotesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/NotesResourceLinks", "exampleSetFlag" : false } ] }, "NotesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/NotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "NotesEntity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "OpenTicketsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/OpenTicketsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "OpenTicketsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/OpenTicketsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/OpenTicketsResourcePostAttributes", "exampleSetFlag" : false } ] }, "OpenTicketsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/OpenTicketsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/OpenTicketsContract_numberResourceAttribute", "exampleSetFlag" : false }, "count" : { "$ref" : "#/components/schemas/OpenTicketsCountResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/OpenTicketsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/OpenTicketsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/OpenTicketsResourceLinks", "exampleSetFlag" : false } ] }, "OpenTicketsCountResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "OpenTicketsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (openTickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "openTickets" ] }, "id" : { "$ref" : "#/components/schemas/OpenTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/OpenTicketsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/openTicket/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "count" : { "$ref" : "#/components/schemas/OpenTicketsCountResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/OpenTicketsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (openTickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "openTickets" ] }, "id" : { "$ref" : "#/components/schemas/OpenTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/OpenTicketsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "OpenTicketsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/OpenTicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OpenTicketsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "count" : { "$ref" : "#/components/schemas/OpenTicketsCountResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsContract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OpenTicketsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/OpenTicketsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsIdResourceAttribute" : { "type" : "object", "properties" : { "account_number" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "contract_number" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "OpenTicketsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/OpenTicketsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/OpenTicketsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/OrganizationsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/OrganizationsCodeResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/OrganizationsDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/OrganizationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "location_id" : { "$ref" : "#/components/schemas/OrganizationsLocation_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/OrganizationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/OrganizationsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/OrganizationsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/OrganizationsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/OrganizationsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/OrganizationsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/OrganizationsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/OrganizationsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/OrganizationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/OrganizationsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "OrganizationsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OrganizationsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/OrganizationsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OrganizationsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "OrganizationsLocation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "OrganizationsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (organizations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "organizations" ] }, "id" : { "$ref" : "#/components/schemas/OrganizationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/OrganizationsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/OrganizationsCodeResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/OrganizationsDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/OrganizationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "location_id" : { "$ref" : "#/components/schemas/OrganizationsLocation_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/OrganizationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/OrganizationsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/OrganizationsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/OrganizationsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/OrganizationsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/OrganizationsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/OrganizationsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/OrganizationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/OrganizationsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/OrganizationsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "OrganizationsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/OrganizationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/OrganizationsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/OrganizationsResourceLinks", "exampleSetFlag" : false } ] }, "OrganizationsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OrganizationsCodeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OrganizationsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "OrganizationsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "OrganizationsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/organizations/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "OrganizationsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OrganizationsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OrganizationsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/OrganizationsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/OrganizationsResourcePostAttributes", "exampleSetFlag" : false } ] }, "OrganizationsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/OrganizationsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (organizations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "organizations" ] }, "id" : { "$ref" : "#/components/schemas/OrganizationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/OrganizationsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/OrganizationsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "OrganizationsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OrganizationsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/OrganizationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OrganizationsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/OrganizationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/OrganizationsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/OrganizationsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/OrganizationsCodeResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/OrganizationsDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/OrganizationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "location_id" : { "$ref" : "#/components/schemas/OrganizationsLocation_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/OrganizationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/OrganizationsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/OrganizationsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/OrganizationsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/OrganizationsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/OrganizationsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/OrganizationsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/OrganizationsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "OrganizationsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "OrganizationsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyCredentialsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PasskeyCredentialsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PasskeyCredentialsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyCredentialsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyCredentialsResourcePostRelationships", "exampleSetFlag" : false } ] }, "PasskeyCredentialsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "client_data" : { "$ref" : "#/components/schemas/PasskeyCredentialsClient_dataResourceAttribute", "exampleSetFlag" : false }, "transports" : { "$ref" : "#/components/schemas/PasskeyCredentialsTransportsResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/PasskeyCredentialsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "passkeyuser_id" : { "$ref" : "#/components/schemas/PasskeyCredentialsPasskeyuser_idResourceAttribute", "exampleSetFlag" : false }, "sign_count" : { "$ref" : "#/components/schemas/PasskeyCredentialsSign_countResourceAttribute", "exampleSetFlag" : false }, "attestation_object" : { "$ref" : "#/components/schemas/PasskeyCredentialsAttestation_objectResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PasskeyCredentialsCreated_byResourceAttribute", "exampleSetFlag" : false }, "authenticator_type" : { "$ref" : "#/components/schemas/PasskeyCredentialsAuthenticator_typeResourceAttribute", "exampleSetFlag" : false }, "credential_id" : { "$ref" : "#/components/schemas/PasskeyCredentialsCredential_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsClient_dataResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyCredentialsCredential_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyCredentialsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "PasskeyCredentialsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "passkeyUser" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsAuthenticator_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyCredentialsAttestation_objectResourceAttribute" : { "type" : "string", "format" : "byte", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyCredentialsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyCredentialsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "client_data" : { "$ref" : "#/components/schemas/PasskeyCredentialsClient_dataResourceAttribute", "exampleSetFlag" : false }, "transports" : { "$ref" : "#/components/schemas/PasskeyCredentialsTransportsResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/PasskeyCredentialsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "passkeyuser_id" : { "$ref" : "#/components/schemas/PasskeyCredentialsPasskeyuser_idResourceAttribute", "exampleSetFlag" : false }, "sign_count" : { "$ref" : "#/components/schemas/PasskeyCredentialsSign_countResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/PasskeyCredentialsCreated_onResourceAttribute", "exampleSetFlag" : false }, "attestation_object" : { "$ref" : "#/components/schemas/PasskeyCredentialsAttestation_objectResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/PasskeyCredentialsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PasskeyCredentialsCreated_byResourceAttribute", "exampleSetFlag" : false }, "authenticator_type" : { "$ref" : "#/components/schemas/PasskeyCredentialsAuthenticator_typeResourceAttribute", "exampleSetFlag" : false }, "credential_id" : { "$ref" : "#/components/schemas/PasskeyCredentialsCredential_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsPasskeyuser_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PasskeyCredentialsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyCredentialsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyCredentialsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "PasskeyCredentialsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "PasskeyCredentialsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (passkeyCredentials)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "passkeyCredentials" ] }, "id" : { "$ref" : "#/components/schemas/PasskeyCredentialsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PasskeyCredentialsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsPasskeyUserResourceAttribute" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PasskeyCredentialsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "PasskeyCredentialsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "passkeyUser" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyCredentialsSign_countResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PasskeyCredentialsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (passkeyCredentials)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "passkeyCredentials" ] }, "id" : { "$ref" : "#/components/schemas/PasskeyCredentialsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/passkeyCredentials/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "passkeyUser" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/passkeyCredentials/{id}/relationships/passkeyUser" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/passkeyCredentials/{id}/passkeyUser" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "client_data" : { "$ref" : "#/components/schemas/PasskeyCredentialsClient_dataResourceAttribute", "exampleSetFlag" : false }, "transports" : { "$ref" : "#/components/schemas/PasskeyCredentialsTransportsResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/PasskeyCredentialsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "passkeyuser_id" : { "$ref" : "#/components/schemas/PasskeyCredentialsPasskeyuser_idResourceAttribute", "exampleSetFlag" : false }, "sign_count" : { "$ref" : "#/components/schemas/PasskeyCredentialsSign_countResourceAttribute", "exampleSetFlag" : false }, "attestation_object" : { "$ref" : "#/components/schemas/PasskeyCredentialsAttestation_objectResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/PasskeyCredentialsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PasskeyCredentialsCreated_byResourceAttribute", "exampleSetFlag" : false }, "authenticator_type" : { "$ref" : "#/components/schemas/PasskeyCredentialsAuthenticator_typeResourceAttribute", "exampleSetFlag" : false }, "credential_id" : { "$ref" : "#/components/schemas/PasskeyCredentialsCredential_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyCredentialsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyCredentialsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyCredentialsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyCredentialsResourceLinks", "exampleSetFlag" : false } ] }, "PasskeyCredentialsTransportsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyUsersCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "PasskeyUsersDisplay_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyUsersLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "PasskeyUsersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/PasskeyUsersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "user_type" : { "$ref" : "#/components/schemas/PasskeyUsersUser_typeResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/PasskeyUsersUser_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/PasskeyUsersCreated_onResourceAttribute", "exampleSetFlag" : false }, "user_name" : { "$ref" : "#/components/schemas/PasskeyUsersUser_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/PasskeyUsersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/PasskeyUsersDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PasskeyUsersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "passkeyCredentials" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : false, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : false, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyUsersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyUsersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyUsersResourceLinks", "exampleSetFlag" : false } ] }, "PasskeyUsersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PasskeyUsersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyUsersResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyUsersResourcePostRelationships", "exampleSetFlag" : false } ] }, "PasskeyUsersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (passkeyUsers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "passkeyUsers" ] }, "id" : { "$ref" : "#/components/schemas/PasskeyUsersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/PasskeyUsersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "PasskeyUsersUser_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyUsersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "passkeyCredentials" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/passkeyUsers/{id}/relationships/passkeyCredentials" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/passkeyUsers/{id}/passkeyCredentials" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : false, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : false, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyUsersPasskeyCredentialsResourceAttribute" : { "uniqueItems" : false, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "PasskeyUsersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (passkeyUsers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "passkeyUsers" ] }, "id" : { "$ref" : "#/components/schemas/PasskeyUsersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyUsersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "PasskeyUsersCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyUsersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyUsersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyUsersResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PasskeyUsersResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersUser_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PasskeyUsersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/PasskeyUsersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "user_type" : { "$ref" : "#/components/schemas/PasskeyUsersUser_typeResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/PasskeyUsersUser_idResourceAttribute", "exampleSetFlag" : false }, "user_name" : { "$ref" : "#/components/schemas/PasskeyUsersUser_nameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/PasskeyUsersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/PasskeyUsersDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PasskeyUsersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/PasskeyUsersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "user_type" : { "$ref" : "#/components/schemas/PasskeyUsersUser_typeResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/PasskeyUsersUser_idResourceAttribute", "exampleSetFlag" : false }, "user_name" : { "$ref" : "#/components/schemas/PasskeyUsersUser_nameResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/PasskeyUsersDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PasskeyUsersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "passkeyCredentials" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : false, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : false, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PasskeyUsersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PasskeyUsersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PasskeyUsersUser_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PasskeyUsersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/passkeyUsers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "claims" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/payeeAddresses/{id}/relationships/claims" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/payeeAddresses/{id}/claims" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PayeeAddressesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PayeeAddressesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PayeeAddressesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PayeeAddressesResourceLinks", "exampleSetFlag" : false } ] }, "PayeeAddressesClaimsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ClaimsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "PayeeAddressesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PayeeAddressesPostResourceReference", "exampleSetFlag" : false } ] }, "PayeeAddressesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PayeeAddressesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "payee" : { "$ref" : "#/components/schemas/PayeeAddressesPayeeResourceAttribute", "exampleSetFlag" : false }, "end_date" : { "$ref" : "#/components/schemas/PayeeAddressesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "workday_vendor_number" : { "$ref" : "#/components/schemas/PayeeAddressesWorkday_vendor_numberResourceAttribute", "exampleSetFlag" : false }, "address" : { "$ref" : "#/components/schemas/PayeeAddressesAddressResourceAttribute", "exampleSetFlag" : false }, "claim_payee_id" : { "$ref" : "#/components/schemas/PayeeAddressesClaim_payee_idResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/PayeeAddressesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesWorkday_vendor_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PayeeAddressesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PayeeAddressesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesPayeeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PayeeAddressesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PayeeAddressesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "PayeeAddressesClaim_payee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PayeeAddressesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PayeeAddressesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PayeeAddressesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PayeeAddressesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/payeeAddresses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/PayeeAddressesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "PayeeAddressesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (payeeAddresses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "payeeAddresses" ] }, "id" : { "$ref" : "#/components/schemas/PayeeAddressesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (payeeAddresses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "payeeAddresses" ] }, "id" : { "$ref" : "#/components/schemas/PayeeAddressesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PayeeAddressesAddressResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PayeeAddressesEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "PayeeAddressesStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "PayeeAddressesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PayeeAddressesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PhotoCompliancesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PhotoCompliancesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PhotoCompliancesPurposeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PhotoCompliancesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (photoCompliances)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "photoCompliances" ] }, "id" : { "$ref" : "#/components/schemas/PhotoCompliancesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PhotoCompliancesCustomer_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PhotoCompliancesModelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PhotoCompliancesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PhotoCompliancesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PhotoCompliancesCustomerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PhotoCompliancesCheck_visit_boundaryResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "PhotoCompliancesPerimissionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PhotoCompliancesCustomer_facility_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PhotoCompliancesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/photoCompliances/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "PhotoCompliancesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PhotoCompliancesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "PhotoCompliancesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PhotoCompliancesPostResourceReference", "exampleSetFlag" : false } ] }, "PhotoCompliancesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PhotoCompliancesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PhotoCompliancesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PhotoCompliancesResourceLinks", "exampleSetFlag" : false } ] }, "PhotoCompliancesModel_versionResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PhotoCompliancesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/PhotoCompliancesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "PhotoCompliancesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PhotoCompliancesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PhotoCompliancesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (photoCompliances)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "photoCompliances" ] }, "id" : { "$ref" : "#/components/schemas/PhotoCompliancesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PhotoCompliancesStatus_codesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PhotoCompliancesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PhotoCompliancesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PhotoCompliancesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PhotoCompliancesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PhotoCompliancesMessageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PhotoCompliancesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PhotoCompliancesDistanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "PhotoCompliancesDeletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "PhotoCompliancesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "model_version" : { "$ref" : "#/components/schemas/PhotoCompliancesModel_versionResourceAttribute", "exampleSetFlag" : false }, "deleted" : { "$ref" : "#/components/schemas/PhotoCompliancesDeletedResourceAttribute", "exampleSetFlag" : false }, "distance" : { "$ref" : "#/components/schemas/PhotoCompliancesDistanceResourceAttribute", "exampleSetFlag" : false }, "purpose" : { "$ref" : "#/components/schemas/PhotoCompliancesPurposeResourceAttribute", "exampleSetFlag" : false }, "status_codes" : { "$ref" : "#/components/schemas/PhotoCompliancesStatus_codesResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/PhotoCompliancesModelResourceAttribute", "exampleSetFlag" : false }, "perimission" : { "$ref" : "#/components/schemas/PhotoCompliancesPerimissionResourceAttribute", "exampleSetFlag" : false }, "customer_name" : { "$ref" : "#/components/schemas/PhotoCompliancesCustomer_nameResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/PhotoCompliancesMessageResourceAttribute", "exampleSetFlag" : false }, "customer_facility_type" : { "$ref" : "#/components/schemas/PhotoCompliancesCustomer_facility_typeResourceAttribute", "exampleSetFlag" : false }, "check_visit_boundary" : { "$ref" : "#/components/schemas/PhotoCompliancesCheck_visit_boundaryResourceAttribute", "exampleSetFlag" : false }, "customer" : { "$ref" : "#/components/schemas/PhotoCompliancesCustomerResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesAccruedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "PolicyDropOffEstimatesAttributes3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PolicyDropOffEstimatesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "damage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/relationships/damage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/damage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DamagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "financialPeriod" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/relationships/financialPeriod" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/financialPeriod" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigationDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/relationships/investigationDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/investigationDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "district" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/relationships/district" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/district" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "wfNotification" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/relationships/wfNotification" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/wfNotification" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "quickCValue" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/relationships/quickCValue" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/quickCValue" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cmsRequest" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/relationships/cmsRequest" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}/cmsRequest" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesChange_reasonResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PolicyDropOffEstimatesAttributes2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PolicyDropOffEstimatesApproverResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesCmsRequestResourceAttribute" : { "$ref" : "#/components/schemas/CmsRequestsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesDamageResourceAttribute" : { "$ref" : "#/components/schemas/DamagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesInvestigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesDifference_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesAccrual_balanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "PolicyDropOffEstimatesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "dispute_reason_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesDispute_reason_idResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesVersion_numberResourceAttribute", "exampleSetFlag" : false }, "estimate_category_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesEstimate_category_idResourceAttribute", "exampleSetFlag" : false }, "difference_reason_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesDifference_reason_idResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "dispute_estimate" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesDispute_estimateResourceAttribute", "exampleSetFlag" : false }, "accrual_amount" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesAccrual_amountResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "change_reason" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesChange_reasonResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_month" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPolicy_drop_off_monthResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "adjusted_amount" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesAdjusted_amountResourceAttribute", "exampleSetFlag" : false }, "count_against_quality_ratio" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesCount_against_quality_ratioResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPolicy_drop_offResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "wf_notification_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesWf_notification_idResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_amount" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPolicy_drop_off_amountResourceAttribute", "exampleSetFlag" : false }, "period_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPeriod_idResourceAttribute", "exampleSetFlag" : false }, "completed_by" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesCompleted_byResourceAttribute", "exampleSetFlag" : false }, "damage_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesDamage_idResourceAttribute", "exampleSetFlag" : false }, "approver" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesApproverResourceAttribute", "exampleSetFlag" : false }, "amount" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesAmountResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesActiveResourceAttribute", "exampleSetFlag" : false }, "completed" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesCompletedResourceAttribute", "exampleSetFlag" : false }, "prorated_payment_amount" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesProrated_payment_amountResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesCreated_byResourceAttribute", "exampleSetFlag" : false }, "estimate_date" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesEstimate_dateResourceAttribute", "exampleSetFlag" : false }, "default_amount" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesDefault_amountResourceAttribute", "exampleSetFlag" : false }, "accrual_balance" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesAccrual_balanceResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesCreated_onResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "accrued" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesAccruedResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_period_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPolicy_drop_off_period_idResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "policy_drop_off_year" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPolicy_drop_off_yearResourceAttribute", "exampleSetFlag" : false }, "attributes3" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesAttributes3ResourceAttribute", "exampleSetFlag" : false }, "third_party_name" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesThird_party_nameResourceAttribute", "exampleSetFlag" : false }, "attributes2" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesAttributes2ResourceAttribute", "exampleSetFlag" : false }, "request_id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesRequest_idResourceAttribute", "exampleSetFlag" : false }, "attributes1" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesAttributes1ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesPolicy_drop_off_period_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesEstimate_category_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesPolicy_drop_offResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "PolicyDropOffEstimatesThird_party_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PolicyDropOffEstimatesEstimate_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (policyDropOffEstimates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "policyDropOffEstimates" ] }, "id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesWf_notification_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesAdjusted_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "PolicyDropOffEstimatesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PolicyDropOffEstimatesWfNotificationResourceAttribute" : { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesPolicy_drop_off_yearResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesAmountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "PolicyDropOffEstimatesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "PolicyDropOffEstimatesAttributes1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PolicyDropOffEstimatesPolicy_drop_off_monthResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesCount_against_quality_ratioResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "PolicyDropOffEstimatesCompleted_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesPolicy_drop_off_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "PolicyDropOffEstimatesAccrual_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "PolicyDropOffEstimatesInvestigation_detail_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesRequest_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "PolicyDropOffEstimatesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesPeriod_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesDispute_estimateResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "PolicyDropOffEstimatesWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesInvestigationDetailResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesFinancialPeriodResourceAttribute" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (policyDropOffEstimates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "policyDropOffEstimates" ] }, "id" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/policyDropOffEstimates/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesDefault_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "PolicyDropOffEstimatesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "PolicyDropOffEstimatesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesProrated_payment_amountResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "PolicyDropOffEstimatesQuickCValueResourceAttribute" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPostResourceReference", "exampleSetFlag" : false } ] }, "PolicyDropOffEstimatesDamage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesDistrictResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PolicyDropOffEstimatesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesVersion_numberResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PolicyDropOffEstimatesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceLinks", "exampleSetFlag" : false } ] }, "PolicyDropOffEstimatesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "PolicyDropOffEstimatesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PolicyDropOffEstimatesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "PolicyDropOffEstimatesCompletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "PolicyDropOffEstimatesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PolicyDropOffEstimatesDispute_reason_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ProfileLevelsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfileLevelsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "profileValues" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profileLevels/{id}/relationships/profileValues" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profileLevels/{id}/profileValues" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profileLevels/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsLevel_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfileLevelsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ProfileLevelsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (profileLevels)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "profileLevels" ] }, "id" : { "$ref" : "#/components/schemas/ProfileLevelsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsProfileValuesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ProfileLevelsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ProfileLevelsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileLevelsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ProfileLevelsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfileLevelsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ProfileLevelsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileLevelsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProfileLevelsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileLevelsResourcePostAttributes", "exampleSetFlag" : false } ] }, "ProfileLevelsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ProfileLevelsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ProfileLevelsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileLevelsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileLevelsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileLevelsResourceLinks", "exampleSetFlag" : false } ] }, "ProfileLevelsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ProfileLevelsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ProfileLevelsCreated_onResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/ProfileLevelsDescriptionResourceAttribute", "exampleSetFlag" : false }, "level_number" : { "$ref" : "#/components/schemas/ProfileLevelsLevel_numberResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ProfileLevelsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ProfileLevelsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ProfileLevelsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/ProfileLevelsDescriptionResourceAttribute", "exampleSetFlag" : false }, "level_number" : { "$ref" : "#/components/schemas/ProfileLevelsLevel_numberResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ProfileLevelsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ProfileLevelsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ProfileLevelsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/ProfileLevelsDescriptionResourceAttribute", "exampleSetFlag" : false }, "level_number" : { "$ref" : "#/components/schemas/ProfileLevelsLevel_numberResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ProfileLevelsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileLevelsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (profileLevels)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "profileLevels" ] }, "id" : { "$ref" : "#/components/schemas/ProfileLevelsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileLevelsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfileLevelsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfileValuesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileValuesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ProfileValuesProfile_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ProfileValuesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (profileValues)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "profileValues" ] }, "id" : { "$ref" : "#/components/schemas/ProfileValuesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileValuesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProfileValuesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileValuesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileValuesResourcePostRelationships", "exampleSetFlag" : false } ] }, "ProfileValuesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ProfileValuesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ProfileValuesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "profile_level_id" : { "$ref" : "#/components/schemas/ProfileValuesProfile_level_idResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/ProfileValuesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ProfileValuesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ProfileValuesCreated_onResourceAttribute", "exampleSetFlag" : false }, "profile_id" : { "$ref" : "#/components/schemas/ProfileValuesProfile_idResourceAttribute", "exampleSetFlag" : false }, "value_data_type" : { "$ref" : "#/components/schemas/ProfileValuesValue_data_typeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/ProfileValuesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/ProfileValuesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ProfileValuesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/ProfileValuesValueResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ProfileValuesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "profile" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "profileLevel" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profileValues/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesProfile_level_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ProfileValuesValueResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfileValuesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "profile" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profileValues/{id}/relationships/profile" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profileValues/{id}/profile" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "profileLevel" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profileValues/{id}/relationships/profileLevel" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profileValues/{id}/profileLevel" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileValuesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileValuesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileValuesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileValuesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfileValuesResourceLinks", "exampleSetFlag" : false } ] }, "ProfileValuesProfileLevelResourceAttribute" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ProfileValuesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ProfileValuesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "profile_level_id" : { "$ref" : "#/components/schemas/ProfileValuesProfile_level_idResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/ProfileValuesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ProfileValuesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "profile_id" : { "$ref" : "#/components/schemas/ProfileValuesProfile_idResourceAttribute", "exampleSetFlag" : false }, "value_data_type" : { "$ref" : "#/components/schemas/ProfileValuesValue_data_typeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/ProfileValuesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/ProfileValuesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/ProfileValuesValueResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ProfileValuesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ProfileValuesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ProfileValuesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ProfileValuesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ProfileValuesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "profile_level_id" : { "$ref" : "#/components/schemas/ProfileValuesProfile_level_idResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/ProfileValuesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ProfileValuesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "profile_id" : { "$ref" : "#/components/schemas/ProfileValuesProfile_idResourceAttribute", "exampleSetFlag" : false }, "value_data_type" : { "$ref" : "#/components/schemas/ProfileValuesValue_data_typeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/ProfileValuesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/ProfileValuesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ProfileValuesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/ProfileValuesValueResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ProfileValuesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (profileValues)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "profileValues" ] }, "id" : { "$ref" : "#/components/schemas/ProfileValuesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfileValuesProfileResourceAttribute" : { "$ref" : "#/components/schemas/ProfilesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ProfileValuesValue_data_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfileValuesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ProfileValuesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfileValuesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfileValuesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "profile" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "profileLevel" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProfileLevelsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ProfilesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ProfilesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ProfilesNameResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/ProfilesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ProfilesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ProfilesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ProfilesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfilesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "profileValues" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profiles/{id}/relationships/profileValues" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profiles/{id}/profileValues" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ProfilesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ProfilesNameResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/ProfilesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ProfilesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ProfilesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ProfilesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfilesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (profiles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "profiles" ] }, "id" : { "$ref" : "#/components/schemas/ProfilesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ProfilesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfilesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProfilesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfilesResourcePostAttributes", "exampleSetFlag" : false } ] }, "ProfilesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ProfilesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ProfilesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesProfileValuesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfileValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ProfilesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ProfilesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ProfilesNameResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/ProfilesDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ProfilesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProfilesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/profiles/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProfilesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfilesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfilesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProfilesResourceLinks", "exampleSetFlag" : false } ] }, "ProfilesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ProfilesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (profiles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "profiles" ] }, "id" : { "$ref" : "#/components/schemas/ProfilesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfilesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProfilesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProfilesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ProfilesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProjectTicketsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/projectTickets/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProjectTicketsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ProjectTicketsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProjectTicketsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProjectTicketsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ProjectTicketsResourceLinks", "exampleSetFlag" : false } ] }, "ProjectTicketsLocatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ProjectTicketsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ProjectTicketsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/projectTickets/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/projectTickets/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/projectTickets/{id}/relationships/locates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/projectTickets/{id}/locates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProjectTicketsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : false, "exampleSetFlag" : false }, "ProjectTicketsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (projectTickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "projectTickets" ] }, "id" : { "$ref" : "#/components/schemas/ProjectTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsIdentified_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ProjectTicketsIdentified_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ProjectTicketsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (projectTickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "projectTickets" ] }, "id" : { "$ref" : "#/components/schemas/ProjectTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ProjectTicketsPostResourceReference", "exampleSetFlag" : false } ] }, "ProjectTicketsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ProjectTicketsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "identified_by_id" : { "$ref" : "#/components/schemas/ProjectTicketsIdentified_by_idResourceAttribute", "exampleSetFlag" : false }, "identified_date" : { "$ref" : "#/components/schemas/ProjectTicketsIdentified_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ProjectTicketsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ProjectTicketsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "PumpDevicePostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PumpDevicePostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDeviceResourcePostRelationships", "exampleSetFlag" : false } ] }, "PumpDeviceImedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceSerial_numberResourceAttribute" : { "type" : "string", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PumpDeviceResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PumpDeviceResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "PumpDeviceImeiResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDeviceHost_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/PumpDeviceResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "PumpDeviceIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDeviceModelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceAvailable_gps_portsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicePostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PumpDevicePostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicePump_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "PumpDeviceResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PumpDeviceResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceIp_addressResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "memory" : { "$ref" : "#/components/schemas/PumpDeviceMemoryResourceAttribute", "exampleSetFlag" : false }, "available_gps_ports" : { "$ref" : "#/components/schemas/PumpDeviceAvailable_gps_portsResourceAttribute", "exampleSetFlag" : false }, "safety_screen_triggers_24" : { "$ref" : "#/components/schemas/PumpDeviceSafety_screen_triggers_24ResourceAttribute", "exampleSetFlag" : false }, "os_version" : { "$ref" : "#/components/schemas/PumpDeviceOs_versionResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/PumpDeviceSerial_numberResourceAttribute", "exampleSetFlag" : false }, "safety_screen_version" : { "$ref" : "#/components/schemas/PumpDeviceSafety_screen_versionResourceAttribute", "exampleSetFlag" : false }, "ip_address" : { "$ref" : "#/components/schemas/PumpDeviceIp_addressResourceAttribute", "exampleSetFlag" : false }, "pump_date" : { "$ref" : "#/components/schemas/PumpDevicePump_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PumpDeviceCreated_byResourceAttribute", "exampleSetFlag" : false }, "imed" : { "$ref" : "#/components/schemas/PumpDeviceImedResourceAttribute", "exampleSetFlag" : false }, "last_gps_lock" : { "$ref" : "#/components/schemas/PumpDeviceLast_gps_lockResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/PumpDeviceCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/PumpDeviceEmployee_idResourceAttribute", "exampleSetFlag" : false }, "os_name" : { "$ref" : "#/components/schemas/PumpDeviceOs_nameResourceAttribute", "exampleSetFlag" : false }, "imei" : { "$ref" : "#/components/schemas/PumpDeviceImeiResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/PumpDeviceModelResourceAttribute", "exampleSetFlag" : false }, "mobile_number" : { "$ref" : "#/components/schemas/PumpDeviceMobile_numberResourceAttribute", "exampleSetFlag" : false }, "host_name" : { "$ref" : "#/components/schemas/PumpDeviceHost_nameResourceAttribute", "exampleSetFlag" : false }, "free_space" : { "$ref" : "#/components/schemas/PumpDeviceFree_spaceResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PumpDeviceResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceAssetResourceAttribute" : { "$ref" : "#/components/schemas/AssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PumpDevicePostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PumpDevicePostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevice/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceMobile_numberResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDeviceResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PumpDeviceResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDeviceResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDeviceResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDeviceResourceLinks", "exampleSetFlag" : false } ] }, "PumpDeviceOs_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceFree_spaceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicePatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PumpDeviceResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDeviceResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceLast_gps_lockResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "PumpDeviceResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (pumpDevice)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "pumpDevice" ] }, "id" : { "$ref" : "#/components/schemas/PumpDeviceIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "PumpDeviceMemoryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevice/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevice/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevice/{id}/relationships/asset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevice/{id}/asset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDeviceSafety_screen_triggers_24ResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDeviceSafety_screen_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceOs_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDeviceEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDevicePostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (pumpDevice)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "pumpDevice" ] }, "id" : { "$ref" : "#/components/schemas/PumpDeviceIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDevicesAvailable_gps_portsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PumpDevicesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/PumpDevicesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesImeiResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDevicesSafety_screen_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "PumpDevicesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PumpDevicesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/PumpDevicesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "PumpDevicesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (pumpDevices)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "pumpDevices" ] }, "id" : { "$ref" : "#/components/schemas/PumpDevicesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesImedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "memory" : { "$ref" : "#/components/schemas/PumpDevicesMemoryResourceAttribute", "exampleSetFlag" : false }, "available_gps_ports" : { "$ref" : "#/components/schemas/PumpDevicesAvailable_gps_portsResourceAttribute", "exampleSetFlag" : false }, "safety_screen_triggers_24" : { "$ref" : "#/components/schemas/PumpDevicesSafety_screen_triggers_24ResourceAttribute", "exampleSetFlag" : false }, "os_version" : { "$ref" : "#/components/schemas/PumpDevicesOs_versionResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/PumpDevicesSerial_numberResourceAttribute", "exampleSetFlag" : false }, "safety_screen_version" : { "$ref" : "#/components/schemas/PumpDevicesSafety_screen_versionResourceAttribute", "exampleSetFlag" : false }, "ip_address" : { "$ref" : "#/components/schemas/PumpDevicesIp_addressResourceAttribute", "exampleSetFlag" : false }, "pump_date" : { "$ref" : "#/components/schemas/PumpDevicesPump_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PumpDevicesCreated_byResourceAttribute", "exampleSetFlag" : false }, "imed" : { "$ref" : "#/components/schemas/PumpDevicesImedResourceAttribute", "exampleSetFlag" : false }, "last_gps_lock" : { "$ref" : "#/components/schemas/PumpDevicesLast_gps_lockResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/PumpDevicesCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/PumpDevicesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "os_name" : { "$ref" : "#/components/schemas/PumpDevicesOs_nameResourceAttribute", "exampleSetFlag" : false }, "imei" : { "$ref" : "#/components/schemas/PumpDevicesImeiResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/PumpDevicesModelResourceAttribute", "exampleSetFlag" : false }, "mobile_number" : { "$ref" : "#/components/schemas/PumpDevicesMobile_numberResourceAttribute", "exampleSetFlag" : false }, "host_name" : { "$ref" : "#/components/schemas/PumpDevicesHost_nameResourceAttribute", "exampleSetFlag" : false }, "free_space" : { "$ref" : "#/components/schemas/PumpDevicesFree_spaceResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PumpDevicesFree_spaceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevices/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevices/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevices/{id}/relationships/asset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevices/{id}/asset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesIp_addressResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesLast_gps_lockResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "PumpDevicesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (pumpDevices)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "pumpDevices" ] }, "id" : { "$ref" : "#/components/schemas/PumpDevicesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PumpDevicesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDevicesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDevicesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesAssetResourceAttribute" : { "$ref" : "#/components/schemas/AssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "PumpDevicesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PumpDevicesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesSerial_numberResourceAttribute" : { "type" : "string", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PumpDevicesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDevicesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDevicesResourcePostRelationships", "exampleSetFlag" : false } ] }, "PumpDevicesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesModelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "memory" : { "$ref" : "#/components/schemas/PumpDevicesMemoryResourceAttribute", "exampleSetFlag" : false }, "available_gps_ports" : { "$ref" : "#/components/schemas/PumpDevicesAvailable_gps_portsResourceAttribute", "exampleSetFlag" : false }, "safety_screen_triggers_24" : { "$ref" : "#/components/schemas/PumpDevicesSafety_screen_triggers_24ResourceAttribute", "exampleSetFlag" : false }, "os_version" : { "$ref" : "#/components/schemas/PumpDevicesOs_versionResourceAttribute", "exampleSetFlag" : false }, "serial_number" : { "$ref" : "#/components/schemas/PumpDevicesSerial_numberResourceAttribute", "exampleSetFlag" : false }, "safety_screen_version" : { "$ref" : "#/components/schemas/PumpDevicesSafety_screen_versionResourceAttribute", "exampleSetFlag" : false }, "ip_address" : { "$ref" : "#/components/schemas/PumpDevicesIp_addressResourceAttribute", "exampleSetFlag" : false }, "pump_date" : { "$ref" : "#/components/schemas/PumpDevicesPump_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PumpDevicesCreated_byResourceAttribute", "exampleSetFlag" : false }, "imed" : { "$ref" : "#/components/schemas/PumpDevicesImedResourceAttribute", "exampleSetFlag" : false }, "last_gps_lock" : { "$ref" : "#/components/schemas/PumpDevicesLast_gps_lockResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/PumpDevicesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "os_name" : { "$ref" : "#/components/schemas/PumpDevicesOs_nameResourceAttribute", "exampleSetFlag" : false }, "imei" : { "$ref" : "#/components/schemas/PumpDevicesImeiResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/PumpDevicesModelResourceAttribute", "exampleSetFlag" : false }, "mobile_number" : { "$ref" : "#/components/schemas/PumpDevicesMobile_numberResourceAttribute", "exampleSetFlag" : false }, "host_name" : { "$ref" : "#/components/schemas/PumpDevicesHost_nameResourceAttribute", "exampleSetFlag" : false }, "free_space" : { "$ref" : "#/components/schemas/PumpDevicesFree_spaceResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PumpDevicesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "PumpDevicesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/pumpDevices/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/PumpDevicesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDevicesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDevicesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/PumpDevicesResourceLinks", "exampleSetFlag" : false } ] }, "PumpDevicesOs_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesMemoryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesMobile_numberResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDevicesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDevicesSafety_screen_triggers_24ResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "PumpDevicesPump_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "PumpDevicesHost_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "asset" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "PumpDevicesOs_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "PumpDevicesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "memory" : { "$ref" : "#/components/schemas/PumpDevicesMemoryResourceAttribute", "exampleSetFlag" : false }, "available_gps_ports" : { "$ref" : "#/components/schemas/PumpDevicesAvailable_gps_portsResourceAttribute", "exampleSetFlag" : false }, "safety_screen_triggers_24" : { "$ref" : "#/components/schemas/PumpDevicesSafety_screen_triggers_24ResourceAttribute", "exampleSetFlag" : false }, "os_version" : { "$ref" : "#/components/schemas/PumpDevicesOs_versionResourceAttribute", "exampleSetFlag" : false }, "safety_screen_version" : { "$ref" : "#/components/schemas/PumpDevicesSafety_screen_versionResourceAttribute", "exampleSetFlag" : false }, "ip_address" : { "$ref" : "#/components/schemas/PumpDevicesIp_addressResourceAttribute", "exampleSetFlag" : false }, "pump_date" : { "$ref" : "#/components/schemas/PumpDevicesPump_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/PumpDevicesCreated_byResourceAttribute", "exampleSetFlag" : false }, "imed" : { "$ref" : "#/components/schemas/PumpDevicesImedResourceAttribute", "exampleSetFlag" : false }, "last_gps_lock" : { "$ref" : "#/components/schemas/PumpDevicesLast_gps_lockResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/PumpDevicesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "os_name" : { "$ref" : "#/components/schemas/PumpDevicesOs_nameResourceAttribute", "exampleSetFlag" : false }, "imei" : { "$ref" : "#/components/schemas/PumpDevicesImeiResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/PumpDevicesModelResourceAttribute", "exampleSetFlag" : false }, "mobile_number" : { "$ref" : "#/components/schemas/PumpDevicesMobile_numberResourceAttribute", "exampleSetFlag" : false }, "host_name" : { "$ref" : "#/components/schemas/PumpDevicesHost_nameResourceAttribute", "exampleSetFlag" : false }, "free_space" : { "$ref" : "#/components/schemas/PumpDevicesFree_spaceResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsChanged_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuestionaireAnswersVersionsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionaireAnswersVersionsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "answer" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsAnswerResourceAttribute", "exampleSetFlag" : false }, "investigation_version_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsInvestigation_version_idResourceAttribute", "exampleSetFlag" : false }, "changed_by" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsChanged_byResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "changed_date" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsChanged_dateResourceAttribute", "exampleSetFlag" : false }, "answer_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsAnswer_idResourceAttribute", "exampleSetFlag" : false }, "question_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsQuestion_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionaireAnswersVersionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "answer" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsAnswerResourceAttribute", "exampleSetFlag" : false }, "investigation_version_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsInvestigation_version_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "changed_by" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsChanged_byResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "changed_date" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsChanged_dateResourceAttribute", "exampleSetFlag" : false }, "answer_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsAnswer_idResourceAttribute", "exampleSetFlag" : false }, "question_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsQuestion_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsInvestigation_detail_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionaireAnswersVersionsQuestionnaireAnswerResourceAttribute" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "QuestionaireAnswersVersionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "answer" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsAnswerResourceAttribute", "exampleSetFlag" : false }, "investigation_version_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsInvestigation_version_idResourceAttribute", "exampleSetFlag" : false }, "changed_by" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsChanged_byResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "changed_date" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsChanged_dateResourceAttribute", "exampleSetFlag" : false }, "answer_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsAnswer_idResourceAttribute", "exampleSetFlag" : false }, "question_id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsQuestion_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuestionaireAnswersVersionsInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "QuestionaireAnswersVersionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsQuestionnaireQuestionResourceAttribute" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "QuestionaireAnswersVersionsAnswer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionaireAnswersVersionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceLinks", "exampleSetFlag" : false } ] }, "QuestionaireAnswersVersionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourcePostAttributes", "exampleSetFlag" : false } ] }, "QuestionaireAnswersVersionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (questionaireAnswersVersions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "questionaireAnswersVersions" ] }, "id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "QuestionaireAnswersVersionsAnswerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionaireAnswersVersionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "QuestionaireAnswersVersionsInvestigation_version_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionaireAnswersVersionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (questionaireAnswersVersions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "questionaireAnswersVersions" ] }, "id" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsQuestion_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionaireAnswersVersionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionaireAnswersVersions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionaireAnswersVersionsChanged_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionaireAnswersVersionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionaireAnswersVersions/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionaireAnswersVersions/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "questionnaireQuestion" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionaireAnswersVersions/{id}/relationships/questionnaireQuestion" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionaireAnswersVersions/{id}/questionnaireQuestion" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "questionnaireAnswer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionaireAnswersVersions/{id}/relationships/questionnaireAnswer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionaireAnswersVersions/{id}/questionnaireAnswer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionaireAnswersVersionsInvestigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionaireAnswersVersionsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuestionnaireAnswersQuestion_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionnaireAnswersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/QuestionnaireAnswersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "answer" : { "$ref" : "#/components/schemas/QuestionnaireAnswersAnswerResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuestionnaireAnswersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "question_id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersQuestion_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuestionnaireAnswersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuestionnaireAnswersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuestionnaireAnswersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireAnswersResourcePostAttributes", "exampleSetFlag" : false } ] }, "QuestionnaireAnswersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "investigation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionnaireAnswers/{id}/relationships/investigation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionnaireAnswers/{id}/investigation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "questionnaireQuestion" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionnaireAnswers/{id}/relationships/questionnaireQuestion" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionnaireAnswers/{id}/questionnaireQuestion" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (questionnaireAnswers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "questionnaireAnswers" ] }, "id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (questionnaireAnswers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "questionnaireAnswers" ] }, "id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuestionnaireAnswersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionnaireAnswers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersInvestigation_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionnaireAnswersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionnaireAnswersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersQuestionnaireQuestionResourceAttribute" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "QuestionnaireAnswersCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireAnswersInvestigation_detail_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionnaireAnswersQuestionaireAnswersVersionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "QuestionnaireAnswersLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireAnswersInvestigationResourceAttribute" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "QuestionnaireAnswersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/QuestionnaireAnswersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "answer" : { "$ref" : "#/components/schemas/QuestionnaireAnswersAnswerResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/QuestionnaireAnswersCreated_onResourceAttribute", "exampleSetFlag" : false }, "questionaireAnswersVersions" : { "$ref" : "#/components/schemas/QuestionnaireAnswersQuestionaireAnswersVersionsResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuestionnaireAnswersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "question_id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersQuestion_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuestionnaireAnswersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersAnswerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireAnswersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireAnswersResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceLinks", "exampleSetFlag" : false } ] }, "QuestionnaireAnswersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuestionnaireAnswersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireAnswersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "QuestionnaireAnswersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "QuestionnaireAnswersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/QuestionnaireAnswersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "answer" : { "$ref" : "#/components/schemas/QuestionnaireAnswersAnswerResourceAttribute", "exampleSetFlag" : false }, "investigation_id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersInvestigation_idResourceAttribute", "exampleSetFlag" : false }, "investigation_detail_id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersInvestigation_detail_idResourceAttribute", "exampleSetFlag" : false }, "question_id" : { "$ref" : "#/components/schemas/QuestionnaireAnswersQuestion_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuestionnaireAnswersCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsRequiredResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "QuestionnaireQuestionsQuestionaireAnswersVersionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "QuestionnaireQuestionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionnaireQuestions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuestionnaireQuestionsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireQuestionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsCriteriaResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireQuestionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (questionnaireQuestions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "questionnaireQuestions" ] }, "id" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "QuestionnaireQuestionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuestionnaireQuestionsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourcePostAttributes", "exampleSetFlag" : false } ] }, "QuestionnaireQuestionsCodeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireQuestionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCodeResourceAttribute", "exampleSetFlag" : false }, "visibility" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsVisibilityResourceAttribute", "exampleSetFlag" : false }, "master_question" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsMaster_questionResourceAttribute", "exampleSetFlag" : false }, "criteria" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCriteriaResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsDescriptionResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsLabelResourceAttribute", "exampleSetFlag" : false }, "type" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsTypeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCreated_byResourceAttribute", "exampleSetFlag" : false }, "required" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsRequiredResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "placement" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsPlacementResourceAttribute", "exampleSetFlag" : false }, "seq" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsSeqResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "QuestionnaireQuestionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCodeResourceAttribute", "exampleSetFlag" : false }, "visibility" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsVisibilityResourceAttribute", "exampleSetFlag" : false }, "master_question" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsMaster_questionResourceAttribute", "exampleSetFlag" : false }, "questionaireAnswersVersions" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsQuestionaireAnswersVersionsResourceAttribute", "exampleSetFlag" : false }, "criteria" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCriteriaResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsDescriptionResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsLabelResourceAttribute", "exampleSetFlag" : false }, "type" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsTypeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCreated_byResourceAttribute", "exampleSetFlag" : false }, "required" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsRequiredResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "placement" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsPlacementResourceAttribute", "exampleSetFlag" : false }, "seq" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsSeqResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsLabelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireQuestionsEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuestionnaireQuestionsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireQuestionsStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuestionnaireQuestionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionnaireQuestionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (questionnaireQuestions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "questionnaireQuestions" ] }, "id" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCodeResourceAttribute", "exampleSetFlag" : false }, "visibility" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsVisibilityResourceAttribute", "exampleSetFlag" : false }, "master_question" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsMaster_questionResourceAttribute", "exampleSetFlag" : false }, "criteria" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCriteriaResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsDescriptionResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsLabelResourceAttribute", "exampleSetFlag" : false }, "type" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsTypeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsCreated_byResourceAttribute", "exampleSetFlag" : false }, "required" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsRequiredResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "placement" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsPlacementResourceAttribute", "exampleSetFlag" : false }, "seq" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsSeqResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsSeqResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuestionnaireQuestionsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireQuestionsMaster_questionResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "QuestionnaireQuestionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "questionnaireAnswers" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionnaireQuestions/{id}/relationships/questionnaireAnswers" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/questionnaireQuestions/{id}/questionnaireAnswers" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceLinks", "exampleSetFlag" : false } ] }, "QuestionnaireQuestionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuestionnaireQuestionsVisibilityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireQuestionsPlacementResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireQuestionsTypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuestionnaireQuestionsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuestionnaireQuestionsQuestionnaireAnswersResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "QuickCodeLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodePatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodeResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuickCodeCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuickCodePostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodePostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/QuickCodeEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodeLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/QuickCodeCodeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuickCodeLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodeDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodeCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/QuickCodeStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/QuickCodeEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodeLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/QuickCodeCodeResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/QuickCodeCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuickCodeLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodeDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodeCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/QuickCodeStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/QuickCodeEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodeLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/QuickCodeCodeResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodeDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodeCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/QuickCodeStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuickCodePostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodePostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeResourcePostAttributes", "exampleSetFlag" : false } ] }, "QuickCodeResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodeResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "QuickCodeStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuickCodeResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (quickCode)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "quickCode" ] }, "id" : { "$ref" : "#/components/schemas/QuickCodeIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodePostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (quickCode)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "quickCode" ] }, "id" : { "$ref" : "#/components/schemas/QuickCodeIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuickCodeResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodeResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeResourceLinks", "exampleSetFlag" : false } ] }, "QuickCodeCodeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeDisplay_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "quickCValues" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodes/{id}/relationships/quickCValues" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodes/{id}/quickCValues" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeQuickCValuesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "QuickCodeResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodeResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodePostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodePostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "QuickCodeValueQuick_code_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuickCodeValueResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodeValueResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "QuickCodeValueInvestigationsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "QuickCodeValuePostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (quickCodeValue)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "quickCodeValue" ] }, "id" : { "$ref" : "#/components/schemas/QuickCodeValueIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuePatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValueResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValueEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "QuickCodeValueResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "quickC" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodeValues/{id}/relationships/quickC" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodeValues/{id}/quickC" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodeResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "investigations" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodeValues/{id}/relationships/investigations" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodeValues/{id}/investigations" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/InvestigationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "estimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodeValues/{id}/relationships/estimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodeValues/{id}/estimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValueDisplay_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeValueEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuickCodeValueResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/quickCodeValues/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValueValueResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeValueResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValueCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeValueResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/QuickCodeValueEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodeValueLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/QuickCodeValueCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuickCodeValueLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "quick_code_id" : { "$ref" : "#/components/schemas/QuickCodeValueQuick_code_idResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodeValueDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/QuickCodeValueValueResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodeValueCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/QuickCodeValueStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValueResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/QuickCodeValueEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodeValueLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "quick_code_id" : { "$ref" : "#/components/schemas/QuickCodeValueQuick_code_idResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodeValueDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/QuickCodeValueValueResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodeValueCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/QuickCodeValueStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuePostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValuePostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuePostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodeValuePostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValueLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeValueResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValueResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "QuickCodeValueStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuickCodeValueQuickCResourceAttribute" : { "$ref" : "#/components/schemas/QuickCodeResourceReference", "nullable" : true, "exampleSetFlag" : false }, "QuickCodeValueResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValueResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValueResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValueResourceLinks", "exampleSetFlag" : false } ] }, "QuickCodeValueResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (quickCodeValue)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "quickCodeValue" ] }, "id" : { "$ref" : "#/components/schemas/QuickCodeValueIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuePostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodeValuePostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValueResourcePostAttributes", "exampleSetFlag" : false } ] }, "QuickCodeValueCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuickCodeValueResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValueIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuickCodeValueResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/QuickCodeValueEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodeValueLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuickCodeValueLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "quick_code_id" : { "$ref" : "#/components/schemas/QuickCodeValueQuick_code_idResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodeValueDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/QuickCodeValueValueResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodeValueCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/QuickCodeValueStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValueLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuickCodeValuesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (quickCodeValues)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "quickCodeValues" ] }, "id" : { "$ref" : "#/components/schemas/QuickCodeValuesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "quickCode" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/quickCodeValues/{id}/relationships/quickCode" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/quickCodeValues/{id}/quickCode" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "quickCode" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "QuickCodeValuesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodeValuesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValuesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValuesResourcePostRelationships", "exampleSetFlag" : false } ] }, "QuickCodeValuesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/QuickCodeValuesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodeValuesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/QuickCodeValuesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "quick_code_id" : { "$ref" : "#/components/schemas/QuickCodeValuesQuick_code_idResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodeValuesDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/QuickCodeValuesValueResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodeValuesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValuesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/QuickCodeValuesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodeValuesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/QuickCodeValuesCreated_onResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/QuickCodeValuesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuickCodeValuesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "quick_code_id" : { "$ref" : "#/components/schemas/QuickCodeValuesQuick_code_idResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodeValuesDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/QuickCodeValuesValueResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodeValuesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesValueResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeValuesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuickCodeValuesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (quickCodeValues)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "quickCodeValues" ] }, "id" : { "$ref" : "#/components/schemas/QuickCodeValuesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/QuickCodeValuesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodeValuesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/QuickCodeValuesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuickCodeValuesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "quick_code_id" : { "$ref" : "#/components/schemas/QuickCodeValuesQuick_code_idResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodeValuesDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "value" : { "$ref" : "#/components/schemas/QuickCodeValuesValueResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodeValuesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeValuesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodeValuesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValuesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValuesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValuesResourceLinks", "exampleSetFlag" : false } ] }, "QuickCodeValuesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodeValuesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValuesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodeValuesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodeValuesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesDisplay_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeValuesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "QuickCodeValuesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodeValuesQuickCodeResourceAttribute" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "QuickCodeValuesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuickCodeValuesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuickCodeValuesQuick_code_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuickCodeValuesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuickCodeValuesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/quickCodeValues/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "quickCode" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodeValuesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuickCodesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodesResourceLinks", "exampleSetFlag" : false } ] }, "QuickCodesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuickCodesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (quickCodes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "quickCodes" ] }, "id" : { "$ref" : "#/components/schemas/QuickCodesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "attributeMappings" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/quickCodes/{id}/relationships/attributeMappings" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/quickCodes/{id}/attributeMappings" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "quickCodeValues" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/quickCodes/{id}/relationships/quickCodeValues" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/quickCodes/{id}/quickCodeValues" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesDisplay_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodesResourcePostAttributes", "exampleSetFlag" : false } ] }, "QuickCodesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuickCodesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "QuickCodesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "QuickCodesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/QuickCodesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/QuickCodesCodeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/QuickCodesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuickCodesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodesDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "QuickCodesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (quickCodes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "quickCodes" ] }, "id" : { "$ref" : "#/components/schemas/QuickCodesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "QuickCodesQuickCodeValuesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "QuickCodesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/QuickCodesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesAttributeMappingsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "QuickCodesCodeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/QuickCodesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/QuickCodesCodeResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/QuickCodesCreated_onResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/QuickCodesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/QuickCodesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodesDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/QuickCodesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/QuickCodesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/QuickCodesCodeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/QuickCodesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/QuickCodesDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/QuickCodesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "QuickCodesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/QuickCodesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "QuickCodesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/QuickCodesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "QuickCodesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/quickCodes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RandomEmployeePicksIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RandomEmployeePicksResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/RandomEmployeePicksLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/RandomEmployeePicksCreated_onResourceAttribute", "exampleSetFlag" : false }, "pick_date" : { "$ref" : "#/components/schemas/RandomEmployeePicksPick_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RandomEmployeePicksLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RandomEmployeePicksCreated_byResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/RandomEmployeePicksEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RandomEmployeePicksPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/RandomEmployeePicksResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "RandomEmployeePicksResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/randomEmployeePicks/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/RandomEmployeePicksLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "pick_date" : { "$ref" : "#/components/schemas/RandomEmployeePicksPick_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RandomEmployeePicksCreated_byResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/RandomEmployeePicksEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RandomEmployeePicksResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RandomEmployeePicksResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RandomEmployeePicksPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RandomEmployeePicksResourcePostAttributes", "exampleSetFlag" : false } ] }, "RandomEmployeePicksPick_dateResourceAttribute" : { "type" : "string", "format" : "date", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RandomEmployeePicksEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RandomEmployeePicksResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/RandomEmployeePicksLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "pick_date" : { "$ref" : "#/components/schemas/RandomEmployeePicksPick_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RandomEmployeePicksLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RandomEmployeePicksCreated_byResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/RandomEmployeePicksEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RandomEmployeePicksPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (randomEmployeePicks)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "randomEmployeePicks" ] }, "id" : { "$ref" : "#/components/schemas/RandomEmployeePicksIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (randomEmployeePicks)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "randomEmployeePicks" ] }, "id" : { "$ref" : "#/components/schemas/RandomEmployeePicksIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RandomEmployeePicksResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RandomEmployeePicksPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RandomEmployeePicksResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RandomEmployeePicksResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RandomEmployeePicksResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RandomEmployeePicksResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "RandomEmployeePicksResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RandomEmployeePicksResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RandomEmployeePicksResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RandomEmployeePicksResourceLinks", "exampleSetFlag" : false } ] }, "RandomEmployeePicksPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RandomEmployeePicksPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/repairReasons/{id}/relationships/assets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/repairReasons/{id}/assets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/RepairReasonsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/RepairReasonsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/RepairReasonsNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/RepairReasonsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/RepairReasonsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/RepairReasonsDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RepairReasonsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/RepairReasonsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/RepairReasonsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/RepairReasonsNotesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/RepairReasonsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/RepairReasonsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/RepairReasonsDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RepairReasonsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RepairReasonsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsNotesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RepairReasonsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RepairReasonsAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "RepairReasonsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RepairReasonsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RepairReasonsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RepairReasonsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (repairReasons)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "repairReasons" ] }, "id" : { "$ref" : "#/components/schemas/RepairReasonsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RepairReasonsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RepairReasonsResourcePostAttributes", "exampleSetFlag" : false } ] }, "RepairReasonsEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "RepairReasonsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RepairReasonsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RepairReasonsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/RepairReasonsEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/RepairReasonsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "notes" : { "$ref" : "#/components/schemas/RepairReasonsNotesResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/RepairReasonsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/RepairReasonsNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/RepairReasonsEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/RepairReasonsDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RepairReasonsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RepairReasonsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/RepairReasonsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "RepairReasonsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RepairReasonsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RepairReasonsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RepairReasonsResourceLinks", "exampleSetFlag" : false } ] }, "RepairReasonsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RepairReasonsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RepairReasonsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "RepairReasonsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/repairReasons/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (repairReasons)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "repairReasons" ] }, "id" : { "$ref" : "#/components/schemas/RepairReasonsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RepairReasonsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RepairReasonsEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "RepairReasonsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RepairReasonsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RepairReasonsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportDataTypesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportDataTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportDataTypesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportDataTypesResourceLinks", "exampleSetFlag" : false } ] }, "ReportDataTypesLabelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportDataTypesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportDataTypes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportDataTypesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ReportDataTypesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportDataTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportDataTypes" ] }, "id" : { "$ref" : "#/components/schemas/ReportDataTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportDataTypes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportDataTypes" ] }, "id" : { "$ref" : "#/components/schemas/ReportDataTypesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ReportDataTypesValue_attributeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesUi_valueResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportDataTypesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesModel_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ReportDataTypesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportDataTypesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportDataTypesResourcePostAttributes", "exampleSetFlag" : false } ] }, "ReportDataTypesTable_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ReportDataTypesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ReportDataTypesDatabase_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesUi_optionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ui_option_custom" : { "$ref" : "#/components/schemas/ReportDataTypesUi_option_customResourceAttribute", "exampleSetFlag" : false }, "database_name" : { "$ref" : "#/components/schemas/ReportDataTypesDatabase_nameResourceAttribute", "exampleSetFlag" : false }, "ui_value" : { "$ref" : "#/components/schemas/ReportDataTypesUi_valueResourceAttribute", "exampleSetFlag" : false }, "value_attribute" : { "$ref" : "#/components/schemas/ReportDataTypesValue_attributeResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/ReportDataTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/ReportDataTypesLabelResourceAttribute", "exampleSetFlag" : false }, "table_name" : { "$ref" : "#/components/schemas/ReportDataTypesTable_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportDataTypesCreated_byResourceAttribute", "exampleSetFlag" : false }, "data_source" : { "$ref" : "#/components/schemas/ReportDataTypesData_sourceResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ReportDataTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "model_name" : { "$ref" : "#/components/schemas/ReportDataTypesModel_nameResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ReportDataTypesCreated_onResourceAttribute", "exampleSetFlag" : false }, "qualifier" : { "$ref" : "#/components/schemas/ReportDataTypesQualifierResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportDataTypesNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportDataTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "ui_option" : { "$ref" : "#/components/schemas/ReportDataTypesUi_optionResourceAttribute", "exampleSetFlag" : false }, "filter_json" : { "$ref" : "#/components/schemas/ReportDataTypesFilter_jsonResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ui_option_custom" : { "$ref" : "#/components/schemas/ReportDataTypesUi_option_customResourceAttribute", "exampleSetFlag" : false }, "database_name" : { "$ref" : "#/components/schemas/ReportDataTypesDatabase_nameResourceAttribute", "exampleSetFlag" : false }, "ui_value" : { "$ref" : "#/components/schemas/ReportDataTypesUi_valueResourceAttribute", "exampleSetFlag" : false }, "value_attribute" : { "$ref" : "#/components/schemas/ReportDataTypesValue_attributeResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/ReportDataTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/ReportDataTypesLabelResourceAttribute", "exampleSetFlag" : false }, "table_name" : { "$ref" : "#/components/schemas/ReportDataTypesTable_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportDataTypesCreated_byResourceAttribute", "exampleSetFlag" : false }, "data_source" : { "$ref" : "#/components/schemas/ReportDataTypesData_sourceResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ReportDataTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "model_name" : { "$ref" : "#/components/schemas/ReportDataTypesModel_nameResourceAttribute", "exampleSetFlag" : false }, "qualifier" : { "$ref" : "#/components/schemas/ReportDataTypesQualifierResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportDataTypesNameResourceAttribute", "exampleSetFlag" : false }, "ui_option" : { "$ref" : "#/components/schemas/ReportDataTypesUi_optionResourceAttribute", "exampleSetFlag" : false }, "filter_json" : { "$ref" : "#/components/schemas/ReportDataTypesFilter_jsonResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportDataTypesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesFilter_jsonResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportDataTypesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesUi_option_customResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportDataTypesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportDataTypesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesData_sourceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportDataTypesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ui_option_custom" : { "$ref" : "#/components/schemas/ReportDataTypesUi_option_customResourceAttribute", "exampleSetFlag" : false }, "database_name" : { "$ref" : "#/components/schemas/ReportDataTypesDatabase_nameResourceAttribute", "exampleSetFlag" : false }, "ui_value" : { "$ref" : "#/components/schemas/ReportDataTypesUi_valueResourceAttribute", "exampleSetFlag" : false }, "value_attribute" : { "$ref" : "#/components/schemas/ReportDataTypesValue_attributeResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/ReportDataTypesDescriptionResourceAttribute", "exampleSetFlag" : false }, "label" : { "$ref" : "#/components/schemas/ReportDataTypesLabelResourceAttribute", "exampleSetFlag" : false }, "table_name" : { "$ref" : "#/components/schemas/ReportDataTypesTable_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportDataTypesCreated_byResourceAttribute", "exampleSetFlag" : false }, "data_source" : { "$ref" : "#/components/schemas/ReportDataTypesData_sourceResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ReportDataTypesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "model_name" : { "$ref" : "#/components/schemas/ReportDataTypesModel_nameResourceAttribute", "exampleSetFlag" : false }, "qualifier" : { "$ref" : "#/components/schemas/ReportDataTypesQualifierResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportDataTypesNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportDataTypesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "ui_option" : { "$ref" : "#/components/schemas/ReportDataTypesUi_optionResourceAttribute", "exampleSetFlag" : false }, "filter_json" : { "$ref" : "#/components/schemas/ReportDataTypesFilter_jsonResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportDataTypesQualifierResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupSectionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportGroupSections)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportGroupSections" ] }, "id" : { "$ref" : "#/components/schemas/ReportGroupSectionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ReportGroupSectionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ReportGroupSectionsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupSectionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ReportGroupSectionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ReportGroupSectionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "report_group_id" : { "$ref" : "#/components/schemas/ReportGroupSectionsReport_group_idResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportGroupSectionsRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportGroupSectionsNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportGroupSectionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/ReportGroupSectionsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/ReportGroupSectionsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportGroupSectionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ReportGroupSectionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroupSections/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportGroup" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "reportsSectionOrders" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportGroupSections)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportGroupSections" ] }, "id" : { "$ref" : "#/components/schemas/ReportGroupSectionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsReport_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportGroupSectionsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupSectionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ReportGroupSectionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ReportGroupSectionsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ReportGroupSectionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ReportGroupSectionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "report_group_id" : { "$ref" : "#/components/schemas/ReportGroupSectionsReport_group_idResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportGroupSectionsRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportGroupSectionsNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportGroupSectionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/ReportGroupSectionsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/ReportGroupSectionsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportGroupSectionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportGroupSectionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportGroup" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroupSections/{id}/relationships/reportGroup" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroupSections/{id}/reportGroup" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "reports" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroupSections/{id}/relationships/reports" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroupSections/{id}/reports" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : false, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : false, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "reportsSectionOrders" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroupSections/{id}/relationships/reportsSectionOrders" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroupSections/{id}/reportsSectionOrders" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsReportGroupResourceAttribute" : { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ReportGroupSectionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourceLinks", "exampleSetFlag" : false } ] }, "ReportGroupSectionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportGroupSectionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportGroup" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "reportsSectionOrders" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ReportGroupSectionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ReportGroupSectionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "report_group_id" : { "$ref" : "#/components/schemas/ReportGroupSectionsReport_group_idResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportGroupSectionsRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportGroupSectionsNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportGroupSectionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/ReportGroupSectionsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/ReportGroupSectionsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportGroupSectionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupSectionsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupSectionsReportsSectionOrdersResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ReportGroupSectionsEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ReportGroupSectionsRequired_rolesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupSectionsReportsResourceAttribute" : { "uniqueItems" : false, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ReportGroupSectionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportGroupSectionsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourcePostRelationships", "exampleSetFlag" : false } ] }, "ReportGroupsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportGroupSections" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "num_columns" : { "$ref" : "#/components/schemas/ReportGroupsNum_columnsResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportGroupsRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "icon" : { "$ref" : "#/components/schemas/ReportGroupsIconResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/ReportGroupsActiveResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/ReportGroupsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "title" : { "$ref" : "#/components/schemas/ReportGroupsTitleResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportGroupsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ReportGroupsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ReportGroupsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportGroupsNameResourceAttribute", "exampleSetFlag" : false }, "linkRoute" : { "$ref" : "#/components/schemas/ReportGroupsLinkRouteResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportGroupsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/ReportGroupsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "info" : { "$ref" : "#/components/schemas/ReportGroupsInfoResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsInfoResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "num_columns" : { "$ref" : "#/components/schemas/ReportGroupsNum_columnsResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportGroupsRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "icon" : { "$ref" : "#/components/schemas/ReportGroupsIconResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/ReportGroupsActiveResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/ReportGroupsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "title" : { "$ref" : "#/components/schemas/ReportGroupsTitleResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportGroupsCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ReportGroupsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportGroupsNameResourceAttribute", "exampleSetFlag" : false }, "linkRoute" : { "$ref" : "#/components/schemas/ReportGroupsLinkRouteResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportGroupsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/ReportGroupsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "info" : { "$ref" : "#/components/schemas/ReportGroupsInfoResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ReportGroupsReportGroupSectionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ReportGroupsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportGroupsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportGroupsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupsResourcePostRelationships", "exampleSetFlag" : false } ] }, "ReportGroupsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportGroupSections" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroups/{id}/relationships/reportGroupSections" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroups/{id}/reportGroupSections" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsLinkRouteResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupsEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ReportGroupsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupsResourceLinks", "exampleSetFlag" : false } ] }, "ReportGroupsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportGroupSections" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "ReportGroupsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ReportGroupsIconResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupsTitleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupsNum_columnsResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportGroupsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ReportGroupsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportGroups)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportGroups" ] }, "id" : { "$ref" : "#/components/schemas/ReportGroupsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportGroups/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "num_columns" : { "$ref" : "#/components/schemas/ReportGroupsNum_columnsResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ReportGroupsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportGroupsRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportGroupsNameResourceAttribute", "exampleSetFlag" : false }, "icon" : { "$ref" : "#/components/schemas/ReportGroupsIconResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/ReportGroupsActiveResourceAttribute", "exampleSetFlag" : false }, "linkRoute" : { "$ref" : "#/components/schemas/ReportGroupsLinkRouteResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/ReportGroupsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "title" : { "$ref" : "#/components/schemas/ReportGroupsTitleResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/ReportGroupsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportGroupsCreated_byResourceAttribute", "exampleSetFlag" : false }, "info" : { "$ref" : "#/components/schemas/ReportGroupsInfoResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportGroupsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportGroupsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportGroupsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ReportGroupsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ReportGroupsRequired_rolesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportGroupsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportGroupsActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ReportGroupsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportGroups)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportGroups" ] }, "id" : { "$ref" : "#/components/schemas/ReportGroupsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ReportSourcesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ReportSourcesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportSourcesRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportSourcesNameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/ReportSourcesActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportSourcesCreated_byResourceAttribute", "exampleSetFlag" : false }, "data_source" : { "$ref" : "#/components/schemas/ReportSourcesData_sourceResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportSourcesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ReportSourcesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reports" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportSourcesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportSources/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportSourcesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportSourcesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ReportSourcesRequired_rolesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportSourcesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ReportSourcesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ReportSourcesCreated_onResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportSourcesRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportSourcesNameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/ReportSourcesActiveResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportSourcesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportSourcesCreated_byResourceAttribute", "exampleSetFlag" : false }, "data_source" : { "$ref" : "#/components/schemas/ReportSourcesData_sourceResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ReportSourcesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ReportSourcesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportSources)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportSources" ] }, "id" : { "$ref" : "#/components/schemas/ReportSourcesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ReportSourcesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportSourcesRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportSourcesNameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/ReportSourcesActiveResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportSourcesCreated_byResourceAttribute", "exampleSetFlag" : false }, "data_source" : { "$ref" : "#/components/schemas/ReportSourcesData_sourceResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportSourcesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ReportSourcesData_sourceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportSourcesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reports" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportSources/{id}/relationships/reports" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportSources/{id}/reports" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportSourcesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportSources)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportSources" ] }, "id" : { "$ref" : "#/components/schemas/ReportSourcesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportSourcesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportSourcesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportSourcesResourcePostRelationships", "exampleSetFlag" : false } ] }, "ReportSourcesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reports" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesReportsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ReportSourcesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportSourcesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportSourcesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportSourcesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportSourcesResourceLinks", "exampleSetFlag" : false } ] }, "ReportSourcesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportSourcesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportSourcesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsReport_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsRequired_rolesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportSource" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "owner" : { "$ref" : "#/components/schemas/ReportsOwnerResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ReportsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "columns" : { "$ref" : "#/components/schemas/ReportsColumnsResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportsRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportsNameResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/ReportsModelResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "report_source_id" : { "$ref" : "#/components/schemas/ReportsReport_source_idResourceAttribute", "exampleSetFlag" : false }, "report_type" : { "$ref" : "#/components/schemas/ReportsReport_typeResourceAttribute", "exampleSetFlag" : false }, "params" : { "$ref" : "#/components/schemas/ReportsParamsResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportsCreated_byResourceAttribute", "exampleSetFlag" : false }, "sql" : { "$ref" : "#/components/schemas/ReportsSqlResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ReportsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ReportsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reports)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reports" ] }, "id" : { "$ref" : "#/components/schemas/ReportsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "owner" : { "$ref" : "#/components/schemas/ReportsOwnerResourceAttribute", "exampleSetFlag" : false }, "columns" : { "$ref" : "#/components/schemas/ReportsColumnsResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportsRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "report_source_id" : { "$ref" : "#/components/schemas/ReportsReport_source_idResourceAttribute", "exampleSetFlag" : false }, "report_type" : { "$ref" : "#/components/schemas/ReportsReport_typeResourceAttribute", "exampleSetFlag" : false }, "params" : { "$ref" : "#/components/schemas/ReportsParamsResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportsCreated_byResourceAttribute", "exampleSetFlag" : false }, "sql" : { "$ref" : "#/components/schemas/ReportsSqlResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ReportsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ReportsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportsNameResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/ReportsModelResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ReportsLast_updated_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSqlResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsResourcePostRelationships", "exampleSetFlag" : false } ] }, "ReportsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ReportsOwnerResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsResourceLinks", "exampleSetFlag" : false } ] }, "ReportsColumnsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reports/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsReport_source_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportsModelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "owner" : { "$ref" : "#/components/schemas/ReportsOwnerResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/ReportsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "columns" : { "$ref" : "#/components/schemas/ReportsColumnsResourceAttribute", "exampleSetFlag" : false }, "required_roles" : { "$ref" : "#/components/schemas/ReportsRequired_rolesResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ReportsNameResourceAttribute", "exampleSetFlag" : false }, "model" : { "$ref" : "#/components/schemas/ReportsModelResourceAttribute", "exampleSetFlag" : false }, "report_source_id" : { "$ref" : "#/components/schemas/ReportsReport_source_idResourceAttribute", "exampleSetFlag" : false }, "report_type" : { "$ref" : "#/components/schemas/ReportsReport_typeResourceAttribute", "exampleSetFlag" : false }, "params" : { "$ref" : "#/components/schemas/ReportsParamsResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ReportsCreated_byResourceAttribute", "exampleSetFlag" : false }, "sql" : { "$ref" : "#/components/schemas/ReportsSqlResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsParamsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsReportSourceResourceAttribute" : { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ReportsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reports)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reports" ] }, "id" : { "$ref" : "#/components/schemas/ReportsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ReportsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportSource" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ReportsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ReportsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportSource" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reports/{id}/relationships/reportSource" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reports/{id}/reportSource" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportSourcesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersReportResourceAttribute" : { "$ref" : "#/components/schemas/ReportsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ReportsSectionOrdersResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportGroupSection" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "report" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportsSectionOrdersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsSectionOrdersResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsSectionOrdersResourcePostRelationships", "exampleSetFlag" : false } ] }, "ReportsSectionOrdersResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportGroupSection" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "report" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsSectionOrdersResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsSectionOrdersResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ReportsSectionOrdersSeqResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportsSectionOrdersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportsSectionOrders)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportsSectionOrders" ] }, "id" : { "$ref" : "#/components/schemas/ReportsSectionOrdersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (reportsSectionOrders)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "reportsSectionOrders" ] }, "id" : { "$ref" : "#/components/schemas/ReportsSectionOrdersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "seq" : { "$ref" : "#/components/schemas/ReportsSectionOrdersSeqResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersIdResourceAttribute" : { "type" : "object", "properties" : { "report_group_section_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "report_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "report_id" : { "$ref" : "#/components/schemas/ReportsSectionOrdersReport_idResourceAttribute", "exampleSetFlag" : false }, "report_group_section_id" : { "$ref" : "#/components/schemas/ReportsSectionOrdersReport_group_section_idResourceAttribute", "exampleSetFlag" : false }, "seq" : { "$ref" : "#/components/schemas/ReportsSectionOrdersSeqResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "seq" : { "$ref" : "#/components/schemas/ReportsSectionOrdersSeqResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersReportGroupSectionResourceAttribute" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ReportsSectionOrdersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ReportsSectionOrdersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceLinks", "exampleSetFlag" : false } ] }, "ReportsSectionOrdersReport_group_section_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ReportsSectionOrdersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportsSectionOrders/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ReportsSectionOrdersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsSectionOrdersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "reportGroupSection" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportsSectionOrders/{id}/relationships/reportGroupSection" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportsSectionOrders/{id}/reportGroupSection" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "report" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportsSectionOrders/{id}/relationships/report" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/reportsSectionOrders/{id}/report" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ReportsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ReportsSectionOrdersReport_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RequestsParam2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/requests/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RequestsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RequestsCompleted_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsParam6ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/RequestsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "RequestsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsParam8ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "RequestsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "param7" : { "$ref" : "#/components/schemas/RequestsParam7ResourceAttribute", "exampleSetFlag" : false }, "param8" : { "$ref" : "#/components/schemas/RequestsParam8ResourceAttribute", "exampleSetFlag" : false }, "param5" : { "$ref" : "#/components/schemas/RequestsParam5ResourceAttribute", "exampleSetFlag" : false }, "param6" : { "$ref" : "#/components/schemas/RequestsParam6ResourceAttribute", "exampleSetFlag" : false }, "request_type" : { "$ref" : "#/components/schemas/RequestsRequest_typeResourceAttribute", "exampleSetFlag" : false }, "param9" : { "$ref" : "#/components/schemas/RequestsParam9ResourceAttribute", "exampleSetFlag" : false }, "end_time" : { "$ref" : "#/components/schemas/RequestsEnd_timeResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/RequestsSession_idResourceAttribute", "exampleSetFlag" : false }, "param3" : { "$ref" : "#/components/schemas/RequestsParam3ResourceAttribute", "exampleSetFlag" : false }, "userid" : { "$ref" : "#/components/schemas/RequestsUseridResourceAttribute", "exampleSetFlag" : false }, "param4" : { "$ref" : "#/components/schemas/RequestsParam4ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RequestsCreated_byResourceAttribute", "exampleSetFlag" : false }, "param1" : { "$ref" : "#/components/schemas/RequestsParam1ResourceAttribute", "exampleSetFlag" : false }, "param2" : { "$ref" : "#/components/schemas/RequestsParam2ResourceAttribute", "exampleSetFlag" : false }, "request_name" : { "$ref" : "#/components/schemas/RequestsRequest_nameResourceAttribute", "exampleSetFlag" : false }, "start_time" : { "$ref" : "#/components/schemas/RequestsStart_timeResourceAttribute", "exampleSetFlag" : false }, "completed_status" : { "$ref" : "#/components/schemas/RequestsCompleted_statusResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/RequestsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "param10" : { "$ref" : "#/components/schemas/RequestsParam10ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RequestsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/RequestsEmp_idResourceAttribute", "exampleSetFlag" : false }, "username" : { "$ref" : "#/components/schemas/RequestsUsernameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RequestsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (requests)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "requests" ] }, "id" : { "$ref" : "#/components/schemas/RequestsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsParam1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsRequest_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsRequest_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsParam5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsEnd_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "RequestsUsernameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsParam9ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RequestsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsSession_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/requests/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/requests/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "param7" : { "$ref" : "#/components/schemas/RequestsParam7ResourceAttribute", "exampleSetFlag" : false }, "param8" : { "$ref" : "#/components/schemas/RequestsParam8ResourceAttribute", "exampleSetFlag" : false }, "param5" : { "$ref" : "#/components/schemas/RequestsParam5ResourceAttribute", "exampleSetFlag" : false }, "param6" : { "$ref" : "#/components/schemas/RequestsParam6ResourceAttribute", "exampleSetFlag" : false }, "request_type" : { "$ref" : "#/components/schemas/RequestsRequest_typeResourceAttribute", "exampleSetFlag" : false }, "param9" : { "$ref" : "#/components/schemas/RequestsParam9ResourceAttribute", "exampleSetFlag" : false }, "end_time" : { "$ref" : "#/components/schemas/RequestsEnd_timeResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/RequestsSession_idResourceAttribute", "exampleSetFlag" : false }, "param3" : { "$ref" : "#/components/schemas/RequestsParam3ResourceAttribute", "exampleSetFlag" : false }, "userid" : { "$ref" : "#/components/schemas/RequestsUseridResourceAttribute", "exampleSetFlag" : false }, "param4" : { "$ref" : "#/components/schemas/RequestsParam4ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RequestsCreated_byResourceAttribute", "exampleSetFlag" : false }, "param1" : { "$ref" : "#/components/schemas/RequestsParam1ResourceAttribute", "exampleSetFlag" : false }, "param2" : { "$ref" : "#/components/schemas/RequestsParam2ResourceAttribute", "exampleSetFlag" : false }, "request_name" : { "$ref" : "#/components/schemas/RequestsRequest_nameResourceAttribute", "exampleSetFlag" : false }, "start_time" : { "$ref" : "#/components/schemas/RequestsStart_timeResourceAttribute", "exampleSetFlag" : false }, "completed_status" : { "$ref" : "#/components/schemas/RequestsCompleted_statusResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/RequestsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/RequestsCreated_onResourceAttribute", "exampleSetFlag" : false }, "param10" : { "$ref" : "#/components/schemas/RequestsParam10ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RequestsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/RequestsEmp_idResourceAttribute", "exampleSetFlag" : false }, "username" : { "$ref" : "#/components/schemas/RequestsUsernameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (requests)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "requests" ] }, "id" : { "$ref" : "#/components/schemas/RequestsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "param7" : { "$ref" : "#/components/schemas/RequestsParam7ResourceAttribute", "exampleSetFlag" : false }, "param8" : { "$ref" : "#/components/schemas/RequestsParam8ResourceAttribute", "exampleSetFlag" : false }, "param5" : { "$ref" : "#/components/schemas/RequestsParam5ResourceAttribute", "exampleSetFlag" : false }, "param6" : { "$ref" : "#/components/schemas/RequestsParam6ResourceAttribute", "exampleSetFlag" : false }, "request_type" : { "$ref" : "#/components/schemas/RequestsRequest_typeResourceAttribute", "exampleSetFlag" : false }, "param9" : { "$ref" : "#/components/schemas/RequestsParam9ResourceAttribute", "exampleSetFlag" : false }, "end_time" : { "$ref" : "#/components/schemas/RequestsEnd_timeResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/RequestsSession_idResourceAttribute", "exampleSetFlag" : false }, "param3" : { "$ref" : "#/components/schemas/RequestsParam3ResourceAttribute", "exampleSetFlag" : false }, "userid" : { "$ref" : "#/components/schemas/RequestsUseridResourceAttribute", "exampleSetFlag" : false }, "param4" : { "$ref" : "#/components/schemas/RequestsParam4ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RequestsCreated_byResourceAttribute", "exampleSetFlag" : false }, "param1" : { "$ref" : "#/components/schemas/RequestsParam1ResourceAttribute", "exampleSetFlag" : false }, "param2" : { "$ref" : "#/components/schemas/RequestsParam2ResourceAttribute", "exampleSetFlag" : false }, "request_name" : { "$ref" : "#/components/schemas/RequestsRequest_nameResourceAttribute", "exampleSetFlag" : false }, "start_time" : { "$ref" : "#/components/schemas/RequestsStart_timeResourceAttribute", "exampleSetFlag" : false }, "completed_status" : { "$ref" : "#/components/schemas/RequestsCompleted_statusResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/RequestsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "param10" : { "$ref" : "#/components/schemas/RequestsParam10ResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/RequestsEmp_idResourceAttribute", "exampleSetFlag" : false }, "username" : { "$ref" : "#/components/schemas/RequestsUsernameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RequestsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RequestsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RequestsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RequestsResourceLinks", "exampleSetFlag" : false } ] }, "RequestsParam4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RequestsEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RequestsUseridResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RequestsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RequestsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "RequestsParam3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsStart_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "RequestsParam10ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RequestsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RequestsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RequestsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RequestsResourcePostAttributes", "exampleSetFlag" : false } ] }, "RequestsParam7ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ResponseLogsWhenrepliedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ResponseLogsFeed_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ResponseLogsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ResponseLogsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ResponseLogsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ResponseLogsResourceLinks", "exampleSetFlag" : false } ] }, "ResponseLogsActivity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ResponseLogsWhen_sentResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ResponseLogsSeq_numberResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ResponseLogsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (responseLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "responseLogs" ] }, "id" : { "$ref" : "#/components/schemas/ResponseLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ResponseLogsReplyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ResponseLogsActivityResourceAttribute" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ResponseLogsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ResponseLogsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (responseLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "responseLogs" ] }, "id" : { "$ref" : "#/components/schemas/ResponseLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ResponseLogsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ResponseLogsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ResponseLogsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseLogsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ResponseLogsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ResponseLogsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/responseLogs/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ResponseLogsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ResponseLogsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ResponseLogsTransmissionBaseResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ResponseLogsSuccessResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ResponseLogsTitleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ResponseLogsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ResponseLogsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ResponseLogsPostResourceReference", "exampleSetFlag" : false } ] }, "ResponseLogsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ResponseLogsCodesentResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ResponseLogsTransmission_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ResponseLogsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "feed" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/responseLogs/{id}/relationships/feed" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/responseLogs/{id}/feed" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "activity" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/responseLogs/{id}/relationships/activity" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/responseLogs/{id}/activity" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionBase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/responseLogs/{id}/relationships/transmissionBase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/responseLogs/{id}/transmissionBase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ResponseLogsFeedResourceAttribute" : { "$ref" : "#/components/schemas/FeedsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ResponseLogsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "seq_number" : { "$ref" : "#/components/schemas/ResponseLogsSeq_numberResourceAttribute", "exampleSetFlag" : false }, "codesent" : { "$ref" : "#/components/schemas/ResponseLogsCodesentResourceAttribute", "exampleSetFlag" : false }, "success" : { "$ref" : "#/components/schemas/ResponseLogsSuccessResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/ResponseLogsActivity_idResourceAttribute", "exampleSetFlag" : false }, "when_sent" : { "$ref" : "#/components/schemas/ResponseLogsWhen_sentResourceAttribute", "exampleSetFlag" : false }, "transmission_id" : { "$ref" : "#/components/schemas/ResponseLogsTransmission_idResourceAttribute", "exampleSetFlag" : false }, "reply" : { "$ref" : "#/components/schemas/ResponseLogsReplyResourceAttribute", "exampleSetFlag" : false }, "title" : { "$ref" : "#/components/schemas/ResponseLogsTitleResourceAttribute", "exampleSetFlag" : false }, "whenreplied" : { "$ref" : "#/components/schemas/ResponseLogsWhenrepliedResourceAttribute", "exampleSetFlag" : false }, "feed_id" : { "$ref" : "#/components/schemas/ResponseLogsFeed_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RoleAccessesUserRoleResourceAttribute" : { "$ref" : "#/components/schemas/UserRolesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "RoleAccessesP_editResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "RoleAccessesP_addResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "RoleAccessesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleAccessesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/roleAccesses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/RoleAccessesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "RoleAccessesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleAccessesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "RoleAccessesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "RoleAccessesRoleActionResourceAttribute" : { "$ref" : "#/components/schemas/RoleActionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "RoleAccessesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "p_delete" : { "$ref" : "#/components/schemas/RoleAccessesP_deleteResourceAttribute", "exampleSetFlag" : false }, "p_edit" : { "$ref" : "#/components/schemas/RoleAccessesP_editResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/RoleAccessesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/RoleAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "p_add" : { "$ref" : "#/components/schemas/RoleAccessesP_addResourceAttribute", "exampleSetFlag" : false }, "p_view" : { "$ref" : "#/components/schemas/RoleAccessesP_viewResourceAttribute", "exampleSetFlag" : false }, "role_id" : { "$ref" : "#/components/schemas/RoleAccessesRole_idResourceAttribute", "exampleSetFlag" : false }, "action_id" : { "$ref" : "#/components/schemas/RoleAccessesAction_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/RoleAccessesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RoleAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RoleAccessesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RoleAccessesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleAccessesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleAccessesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "roleAction" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userRole" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "roleAction" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/roleAccesses/{id}/relationships/roleAction" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/roleAccesses/{id}/roleAction" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userRole" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/roleAccesses/{id}/relationships/userRole" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/roleAccesses/{id}/userRole" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RoleAccessesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesRole_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RoleAccessesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "p_delete" : { "$ref" : "#/components/schemas/RoleAccessesP_deleteResourceAttribute", "exampleSetFlag" : false }, "p_edit" : { "$ref" : "#/components/schemas/RoleAccessesP_editResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/RoleAccessesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/RoleAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "p_add" : { "$ref" : "#/components/schemas/RoleAccessesP_addResourceAttribute", "exampleSetFlag" : false }, "p_view" : { "$ref" : "#/components/schemas/RoleAccessesP_viewResourceAttribute", "exampleSetFlag" : false }, "role_id" : { "$ref" : "#/components/schemas/RoleAccessesRole_idResourceAttribute", "exampleSetFlag" : false }, "action_id" : { "$ref" : "#/components/schemas/RoleAccessesAction_idResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/RoleAccessesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RoleAccessesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleAccessesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleAccessesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleAccessesResourceLinks", "exampleSetFlag" : false } ] }, "RoleAccessesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesP_deleteResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "RoleAccessesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (roleAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "roleAccesses" ] }, "id" : { "$ref" : "#/components/schemas/RoleAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RoleAccessesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleAccessesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleAccessesResourcePostRelationships", "exampleSetFlag" : false } ] }, "RoleAccessesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "RoleAccessesAction_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RoleAccessesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "p_delete" : { "$ref" : "#/components/schemas/RoleAccessesP_deleteResourceAttribute", "exampleSetFlag" : false }, "p_edit" : { "$ref" : "#/components/schemas/RoleAccessesP_editResourceAttribute", "exampleSetFlag" : false }, "effective_end_date" : { "$ref" : "#/components/schemas/RoleAccessesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/RoleAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "p_add" : { "$ref" : "#/components/schemas/RoleAccessesP_addResourceAttribute", "exampleSetFlag" : false }, "p_view" : { "$ref" : "#/components/schemas/RoleAccessesP_viewResourceAttribute", "exampleSetFlag" : false }, "role_id" : { "$ref" : "#/components/schemas/RoleAccessesRole_idResourceAttribute", "exampleSetFlag" : false }, "action_id" : { "$ref" : "#/components/schemas/RoleAccessesAction_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/RoleAccessesCreated_onResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/RoleAccessesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RoleAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RoleAccessesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "roleAction" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userRole" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleAccessesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RoleAccessesP_viewResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "RoleAccessesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RoleAccessesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RoleAccessesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (roleAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "roleAccesses" ] }, "id" : { "$ref" : "#/components/schemas/RoleAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/RoleActionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/RoleActionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/RoleActionsNameResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/RoleActionsDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RoleActionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RoleActionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "roleAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/roleActions/{id}/relationships/roleAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/roleActions/{id}/roleAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RoleActionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleActionsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/roleActions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (roleActions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "roleActions" ] }, "id" : { "$ref" : "#/components/schemas/RoleActionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleActionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleActionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleActionsResourceLinks", "exampleSetFlag" : false } ] }, "RoleActionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RoleActionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/RoleActionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleActionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "RoleActionsRoleAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "RoleActionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleActionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/RoleActionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "RoleActionsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/RoleActionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/RoleActionsNameResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/RoleActionsDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/RoleActionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RoleActionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RoleActionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RoleActionsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RoleActionsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "RoleActionsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/RoleActionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/RoleActionsNameResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/RoleActionsDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/RoleActionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "RoleActionsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RoleActionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/RoleActionsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/RoleActionsResourcePostAttributes", "exampleSetFlag" : false } ] }, "RoleActionsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "RoleActionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (roleActions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "roleActions" ] }, "id" : { "$ref" : "#/components/schemas/RoleActionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobStatusesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobStatusesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "SchedulerJobStatusesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobStatusesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SchedulerJobStatusesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobStatusesResourcePostAttributes", "exampleSetFlag" : false } ] }, "SchedulerJobStatusesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/schedulerJobStatuses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobStatusesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "schedulerJobsInfo" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/schedulerJobStatuses/{id}/relationships/schedulerJobsInfo" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/schedulerJobStatuses/{id}/schedulerJobsInfo" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SchedulerJobStatusesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "SchedulerJobStatusesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SchedulerJobStatusesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "SchedulerJobStatusesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/SchedulerJobStatusesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/SchedulerJobStatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/SchedulerJobStatusesCodeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/SchedulerJobStatusesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/SchedulerJobStatusesDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SchedulerJobStatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesCodeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobStatusesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "SchedulerJobStatusesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/SchedulerJobStatusesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/SchedulerJobStatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/SchedulerJobStatusesCodeResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/SchedulerJobStatusesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/SchedulerJobStatusesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/SchedulerJobStatusesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SchedulerJobStatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesSchedulerJobsInfoResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "SchedulerJobStatusesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobStatusesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "SchedulerJobStatusesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (schedulerJobStatuses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "schedulerJobStatuses" ] }, "id" : { "$ref" : "#/components/schemas/SchedulerJobStatusesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (schedulerJobStatuses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "schedulerJobStatuses" ] }, "id" : { "$ref" : "#/components/schemas/SchedulerJobStatusesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/SchedulerJobStatusesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/SchedulerJobStatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/SchedulerJobStatusesCodeResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/SchedulerJobStatusesCreated_onResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/SchedulerJobStatusesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/SchedulerJobStatusesDescriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/SchedulerJobStatusesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SchedulerJobStatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobStatusesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceLinks", "exampleSetFlag" : false } ] }, "SchedulerJobStatusesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "SchedulerJobsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SchedulerJobsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (schedulerJobs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "schedulerJobs" ] }, "id" : { "$ref" : "#/components/schemas/SchedulerJobsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "schedulerJobStatus" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsJob_groupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsTime_zoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/SchedulerJobsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "SchedulerJobsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsCron_jobResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "SchedulerJobsCron_expressionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/SchedulerJobsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "job_group" : { "$ref" : "#/components/schemas/SchedulerJobsJob_groupResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/SchedulerJobsDescriptionResourceAttribute", "exampleSetFlag" : false }, "repeat_time" : { "$ref" : "#/components/schemas/SchedulerJobsRepeat_timeResourceAttribute", "exampleSetFlag" : false }, "job_class" : { "$ref" : "#/components/schemas/SchedulerJobsJob_classResourceAttribute", "exampleSetFlag" : false }, "time_zone" : { "$ref" : "#/components/schemas/SchedulerJobsTime_zoneResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SchedulerJobsCreated_byResourceAttribute", "exampleSetFlag" : false }, "jobInfo" : { "$ref" : "#/components/schemas/SchedulerJobsJobInfoResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/SchedulerJobsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/SchedulerJobsStatus_idResourceAttribute", "exampleSetFlag" : false }, "cron_job" : { "$ref" : "#/components/schemas/SchedulerJobsCron_jobResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "cron_expression" : { "$ref" : "#/components/schemas/SchedulerJobsCron_expressionResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/SchedulerJobsCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/SchedulerJobsNameResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/SchedulerJobsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "parameters" : { "$ref" : "#/components/schemas/SchedulerJobsParametersResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/SchedulerJobsStart_dateResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/SchedulerJobsEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SchedulerJobsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "SchedulerJobsRepeat_timeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SchedulerJobsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "schedulerJobStatus" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/schedulerJobs/{id}/relationships/schedulerJobStatus" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/schedulerJobs/{id}/schedulerJobStatus" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/schedulerJobs/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/schedulerJobs/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "SchedulerJobsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (schedulerJobs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "schedulerJobs" ] }, "id" : { "$ref" : "#/components/schemas/SchedulerJobsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsParametersResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SchedulerJobsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobsResourcePostRelationships", "exampleSetFlag" : false } ] }, "SchedulerJobsSchedulerJobStatusResourceAttribute" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "SchedulerJobsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/schedulerJobs/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "SchedulerJobsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "schedulerJobStatus" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/SchedulerJobsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "job_group" : { "$ref" : "#/components/schemas/SchedulerJobsJob_groupResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/SchedulerJobsDescriptionResourceAttribute", "exampleSetFlag" : false }, "repeat_time" : { "$ref" : "#/components/schemas/SchedulerJobsRepeat_timeResourceAttribute", "exampleSetFlag" : false }, "job_class" : { "$ref" : "#/components/schemas/SchedulerJobsJob_classResourceAttribute", "exampleSetFlag" : false }, "time_zone" : { "$ref" : "#/components/schemas/SchedulerJobsTime_zoneResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SchedulerJobsCreated_byResourceAttribute", "exampleSetFlag" : false }, "jobInfo" : { "$ref" : "#/components/schemas/SchedulerJobsJobInfoResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/SchedulerJobsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/SchedulerJobsStatus_idResourceAttribute", "exampleSetFlag" : false }, "cron_job" : { "$ref" : "#/components/schemas/SchedulerJobsCron_jobResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "cron_expression" : { "$ref" : "#/components/schemas/SchedulerJobsCron_expressionResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/SchedulerJobsCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/SchedulerJobsNameResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/SchedulerJobsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "parameters" : { "$ref" : "#/components/schemas/SchedulerJobsParametersResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/SchedulerJobsStart_dateResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/SchedulerJobsEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SchedulerJobsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SchedulerJobsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsStatus_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SchedulerJobsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "SchedulerJobsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SchedulerJobsResourceLinks", "exampleSetFlag" : false } ] }, "SchedulerJobsJob_classResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/SchedulerJobsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "job_group" : { "$ref" : "#/components/schemas/SchedulerJobsJob_groupResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/SchedulerJobsDescriptionResourceAttribute", "exampleSetFlag" : false }, "repeat_time" : { "$ref" : "#/components/schemas/SchedulerJobsRepeat_timeResourceAttribute", "exampleSetFlag" : false }, "job_class" : { "$ref" : "#/components/schemas/SchedulerJobsJob_classResourceAttribute", "exampleSetFlag" : false }, "time_zone" : { "$ref" : "#/components/schemas/SchedulerJobsTime_zoneResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SchedulerJobsCreated_byResourceAttribute", "exampleSetFlag" : false }, "jobInfo" : { "$ref" : "#/components/schemas/SchedulerJobsJobInfoResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/SchedulerJobsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/SchedulerJobsStatus_idResourceAttribute", "exampleSetFlag" : false }, "cron_job" : { "$ref" : "#/components/schemas/SchedulerJobsCron_jobResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "cron_expression" : { "$ref" : "#/components/schemas/SchedulerJobsCron_expressionResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/SchedulerJobsCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/SchedulerJobsNameResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/SchedulerJobsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/SchedulerJobsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "parameters" : { "$ref" : "#/components/schemas/SchedulerJobsParametersResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/SchedulerJobsStart_dateResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/SchedulerJobsEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SchedulerJobsJobInfoResourceAttribute" : { "type" : "object", "properties" : { "schedulerName" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "previousFireTime" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "nextFireTime" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "priority" : { "type" : "integer", "format" : "int32", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "nullable" : true, "exampleSetFlag" : false, "types" : [ "object" ] }, "SchedulerJobsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesTkpTicketResourceAttribute" : { "$ref" : "#/components/schemas/TkpTicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ServiceAccountLocateMatchesService_bore_footageResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountLocateMatchesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (serviceAccountLocateMatches)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "serviceAccountLocateMatches" ] }, "id" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesStreet_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesCross_street2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesOur_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesCaller_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesCaller_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (serviceAccountLocateMatches)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "serviceAccountLocateMatches" ] }, "id" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountLocateMatchesWork_done_forResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesCross_street1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "tkpServiceCustomer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/relationships/tkpServiceCustomer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/tkpServiceCustomer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "tkpTicket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/relationships/tkpTicket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/tkpTicket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpTicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TkpTicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "serviceAccount" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/relationships/serviceAccount" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountLocateMatches/{id}/serviceAccount" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesService_account_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountLocateMatchesTkpServiceCustomerResourceAttribute" : { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ServiceAccountLocateMatchesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesShort_noticeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ServiceAccountLocateMatchesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesTypeofworkResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ServiceAccountLocateMatchesCaller_faxResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesTickettypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesEmergencyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ServiceAccountLocateMatchesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesPostResourceReference", "exampleSetFlag" : false } ] }, "ServiceAccountLocateMatchesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cross_street2" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesCross_street2ResourceAttribute", "exampleSetFlag" : false }, "streetname" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesStreetnameResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesCityResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesCountyResourceAttribute", "exampleSetFlag" : false }, "emergency" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesEmergencyResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesLonResourceAttribute", "exampleSetFlag" : false }, "caller_name" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesCaller_nameResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesExcavatorResourceAttribute", "exampleSetFlag" : false }, "service_expire_date" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_expire_dateResourceAttribute", "exampleSetFlag" : false }, "typeofwork" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesTypeofworkResourceAttribute", "exampleSetFlag" : false }, "service_id" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_idResourceAttribute", "exampleSetFlag" : false }, "caller_email" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesCaller_emailResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesStateResourceAttribute", "exampleSetFlag" : false }, "tickettype" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesTickettypeResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesLatResourceAttribute", "exampleSetFlag" : false }, "usic_ticket_type" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesUsic_ticket_typeResourceAttribute", "exampleSetFlag" : false }, "cross_street1" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesCross_street1ResourceAttribute", "exampleSetFlag" : false }, "service_contact_email" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_contact_emailResourceAttribute", "exampleSetFlag" : false }, "service_feed_email" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_feed_emailResourceAttribute", "exampleSetFlag" : false }, "work_done_for" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesWork_done_forResourceAttribute", "exampleSetFlag" : false }, "service_name" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_nameResourceAttribute", "exampleSetFlag" : false }, "caller_fax" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesCaller_faxResourceAttribute", "exampleSetFlag" : false }, "service_customer_id" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_customer_idResourceAttribute", "exampleSetFlag" : false }, "service_billing_type" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_billing_typeResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesTicket_numberResourceAttribute", "exampleSetFlag" : false }, "service_account_id" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_account_idResourceAttribute", "exampleSetFlag" : false }, "service_contact_name" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_contact_nameResourceAttribute", "exampleSetFlag" : false }, "service_type" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_typeResourceAttribute", "exampleSetFlag" : false }, "caller_phone" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesCaller_phoneResourceAttribute", "exampleSetFlag" : false }, "street_number" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesStreet_numberResourceAttribute", "exampleSetFlag" : false }, "our_due_date" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesOur_due_dateResourceAttribute", "exampleSetFlag" : false }, "short_notice" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesShort_noticeResourceAttribute", "exampleSetFlag" : false }, "service_bore_footage" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesService_bore_footageResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesService_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesServiceAccountResourceAttribute" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ServiceAccountLocateMatchesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ServiceAccountLocateMatchesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceLinks", "exampleSetFlag" : false } ] }, "ServiceAccountLocateMatchesTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountLocateMatchesService_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountLocateMatches/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountLocateMatchesService_customer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountLocateMatchesService_expire_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesService_contact_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesService_feed_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "ServiceAccountLocateMatchesStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesUsic_ticket_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesService_contact_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesService_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ServiceAccountLocateMatchesCaller_phoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesStreetnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesExcavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountLocateMatchesService_billing_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ServiceAccountRulesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (serviceAccountRules)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "serviceAccountRules" ] }, "id" : { "$ref" : "#/components/schemas/ServiceAccountRulesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesDeletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ServiceAccountRulesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ServiceAccountRulesPostResourceReference", "exampleSetFlag" : false } ] }, "ServiceAccountRulesStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ServiceAccountRulesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ServiceAccountRulesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ServiceAccountRulesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ServiceAccountRulesResourceLinks", "exampleSetFlag" : false } ] }, "ServiceAccountRulesCreated_by_user_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountRulesCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "serviceAccount" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountRules/{id}/relationships/serviceAccount" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountRules/{id}/serviceAccount" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccountRules/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesModified_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ServiceAccountRulesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesWork_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountRulesServiceAccountResourceAttribute" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "ServiceAccountRulesWork_done_for_includeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ServiceAccountRulesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "ticket_type" : { "$ref" : "#/components/schemas/ServiceAccountRulesTicket_typeResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/ServiceAccountRulesCityResourceAttribute", "exampleSetFlag" : false }, "work_done_for_exclude" : { "$ref" : "#/components/schemas/ServiceAccountRulesWork_done_for_excludeResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/ServiceAccountRulesCountyResourceAttribute", "exampleSetFlag" : false }, "work_type" : { "$ref" : "#/components/schemas/ServiceAccountRulesWork_typeResourceAttribute", "exampleSetFlag" : false }, "excavator_exclude" : { "$ref" : "#/components/schemas/ServiceAccountRulesExcavator_excludeResourceAttribute", "exampleSetFlag" : false }, "excavator_include" : { "$ref" : "#/components/schemas/ServiceAccountRulesExcavator_includeResourceAttribute", "exampleSetFlag" : false }, "modified_date" : { "$ref" : "#/components/schemas/ServiceAccountRulesModified_dateResourceAttribute", "exampleSetFlag" : false }, "service_account_id" : { "$ref" : "#/components/schemas/ServiceAccountRulesService_account_idResourceAttribute", "exampleSetFlag" : false }, "created_by_user_id" : { "$ref" : "#/components/schemas/ServiceAccountRulesCreated_by_user_idResourceAttribute", "exampleSetFlag" : false }, "external" : { "$ref" : "#/components/schemas/ServiceAccountRulesExternalResourceAttribute", "exampleSetFlag" : false }, "deleted" : { "$ref" : "#/components/schemas/ServiceAccountRulesDeletedResourceAttribute", "exampleSetFlag" : false }, "work_done_for_include" : { "$ref" : "#/components/schemas/ServiceAccountRulesWork_done_for_includeResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/ServiceAccountRulesStateResourceAttribute", "exampleSetFlag" : false }, "created_date" : { "$ref" : "#/components/schemas/ServiceAccountRulesCreated_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesExternalResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ServiceAccountRulesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ServiceAccountRulesWork_done_for_excludeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountRulesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesService_account_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountRulesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesExcavator_excludeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (serviceAccountRules)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "serviceAccountRules" ] }, "id" : { "$ref" : "#/components/schemas/ServiceAccountRulesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountRulesTicket_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesExcavator_includeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountRulesCreated_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsServiceAccountLocateMatchesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ServiceAccountsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (serviceAccounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "serviceAccounts" ] }, "id" : { "$ref" : "#/components/schemas/ServiceAccountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "service_type" : { "$ref" : "#/components/schemas/ServiceAccountsService_typeResourceAttribute", "exampleSetFlag" : false }, "contact_name" : { "$ref" : "#/components/schemas/ServiceAccountsContact_nameResourceAttribute", "exampleSetFlag" : false }, "deleted" : { "$ref" : "#/components/schemas/ServiceAccountsDeletedResourceAttribute", "exampleSetFlag" : false }, "expire_date" : { "$ref" : "#/components/schemas/ServiceAccountsExpire_dateResourceAttribute", "exampleSetFlag" : false }, "service_name" : { "$ref" : "#/components/schemas/ServiceAccountsService_nameResourceAttribute", "exampleSetFlag" : false }, "service_id" : { "$ref" : "#/components/schemas/ServiceAccountsService_idResourceAttribute", "exampleSetFlag" : false }, "billing_type" : { "$ref" : "#/components/schemas/ServiceAccountsBilling_typeResourceAttribute", "exampleSetFlag" : false }, "created_date" : { "$ref" : "#/components/schemas/ServiceAccountsCreated_dateResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/ServiceAccountsCustomer_idResourceAttribute", "exampleSetFlag" : false }, "modified_date" : { "$ref" : "#/components/schemas/ServiceAccountsModified_dateResourceAttribute", "exampleSetFlag" : false }, "contact_email" : { "$ref" : "#/components/schemas/ServiceAccountsContact_emailResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsServiceAccountRulesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "ServiceAccountsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ServiceAccountsModified_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsBilling_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "tkpServiceCustomer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccounts/{id}/relationships/tkpServiceCustomer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccounts/{id}/tkpServiceCustomer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "serviceAccountLocateMatches" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccounts/{id}/relationships/serviceAccountLocateMatches" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccounts/{id}/serviceAccountLocateMatches" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "serviceAccountRules" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccounts/{id}/relationships/serviceAccountRules" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccounts/{id}/serviceAccountRules" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ServiceAccountsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ServiceAccountsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ServiceAccountsContact_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsService_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (serviceAccounts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "serviceAccounts" ] }, "id" : { "$ref" : "#/components/schemas/ServiceAccountsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsContact_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsService_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/serviceAccounts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsService_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsCreated_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ServiceAccountsPostResourceReference", "exampleSetFlag" : false } ] }, "ServiceAccountsDeletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "ServiceAccountsExpire_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ServiceAccountsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ServiceAccountsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ServiceAccountsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ServiceAccountsResourceLinks", "exampleSetFlag" : false } ] }, "ServiceAccountsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ServiceAccountsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ServiceAccountsTkpServiceCustomerResourceAttribute" : { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "SessionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/sessions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SessionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_id" : { "$ref" : "#/components/schemas/SessionsCp_user_idResourceAttribute", "exampleSetFlag" : false }, "event" : { "$ref" : "#/components/schemas/SessionsEventResourceAttribute", "exampleSetFlag" : false }, "event_time" : { "$ref" : "#/components/schemas/SessionsEvent_timeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (sessions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "sessions" ] }, "id" : { "$ref" : "#/components/schemas/SessionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SessionsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SessionsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/SessionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "SessionsUserResourceAttribute" : { "$ref" : "#/components/schemas/UsersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "SessionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (sessions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "sessions" ] }, "id" : { "$ref" : "#/components/schemas/SessionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "user" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SessionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_id" : { "$ref" : "#/components/schemas/SessionsCp_user_idResourceAttribute", "exampleSetFlag" : false }, "event" : { "$ref" : "#/components/schemas/SessionsEventResourceAttribute", "exampleSetFlag" : false }, "event_time" : { "$ref" : "#/components/schemas/SessionsEvent_timeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsEvent_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "SessionsEventResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SessionsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_id" : { "$ref" : "#/components/schemas/SessionsCp_user_idResourceAttribute", "exampleSetFlag" : false }, "event" : { "$ref" : "#/components/schemas/SessionsEventResourceAttribute", "exampleSetFlag" : false }, "event_time" : { "$ref" : "#/components/schemas/SessionsEvent_timeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SessionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SessionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SessionsResourceLinks", "exampleSetFlag" : false } ] }, "SessionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "user" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/sessions/{id}/relationships/user" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/sessions/{id}/user" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsCp_user_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SessionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SessionsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SessionsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SessionsResourcePostRelationships", "exampleSetFlag" : false } ] }, "SessionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SessionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "SessionsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "user" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "smsMessage" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessageLogsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessageLogsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SmsMessageLogsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessageLogsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessageLogsResourcePostRelationships", "exampleSetFlag" : false } ] }, "SmsMessageLogsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "smsMessage" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/smsMessageLogs/{id}/relationships/smsMessage" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/smsMessageLogs/{id}/smsMessage" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/smsMessageLogs/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/smsMessageLogs/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsStatus_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessageLogsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessageLogsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "SmsMessageLogsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SmsMessageLogsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessageLogsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessageLogsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessageLogsResourceLinks", "exampleSetFlag" : false } ] }, "SmsMessageLogsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "status_code" : { "$ref" : "#/components/schemas/SmsMessageLogsStatus_codeResourceAttribute", "exampleSetFlag" : false }, "device_id" : { "$ref" : "#/components/schemas/SmsMessageLogsDevice_idResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/SmsMessageLogsCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/SmsMessageLogsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "message_id" : { "$ref" : "#/components/schemas/SmsMessageLogsMessage_idResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SmsMessageLogsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SmsMessageLogsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "smsMessage" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessageLogsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessageLogsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessageLogsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/smsMessageLogs/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (smsMessageLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "smsMessageLogs" ] }, "id" : { "$ref" : "#/components/schemas/SmsMessageLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SmsMessageLogsSmsMessageResourceAttribute" : { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "SmsMessageLogsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SmsMessageLogsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (smsMessageLogs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "smsMessageLogs" ] }, "id" : { "$ref" : "#/components/schemas/SmsMessageLogsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SmsMessageLogsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessageLogsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessageLogsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "SmsMessageLogsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsMessage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SmsMessageLogsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "status_code" : { "$ref" : "#/components/schemas/SmsMessageLogsStatus_codeResourceAttribute", "exampleSetFlag" : false }, "device_id" : { "$ref" : "#/components/schemas/SmsMessageLogsDevice_idResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/SmsMessageLogsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "message_id" : { "$ref" : "#/components/schemas/SmsMessageLogsMessage_idResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SmsMessageLogsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessageLogsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "SmsMessageLogsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "status_code" : { "$ref" : "#/components/schemas/SmsMessageLogsStatus_codeResourceAttribute", "exampleSetFlag" : false }, "device_id" : { "$ref" : "#/components/schemas/SmsMessageLogsDevice_idResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/SmsMessageLogsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "message_id" : { "$ref" : "#/components/schemas/SmsMessageLogsMessage_idResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/SmsMessageLogsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SmsMessageLogsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessageLogsDevice_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessageLogsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "SmsMessagesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "SmsMessagesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessagesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "SmsMessagesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SmsMessagesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessagesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessagesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessagesResourceLinks", "exampleSetFlag" : false } ] }, "SmsMessagesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (smsMessages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "smsMessages" ] }, "id" : { "$ref" : "#/components/schemas/SmsMessagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "SmsMessagesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessagesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/SmsMessagesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/SmsMessagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/SmsMessagesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/SmsMessagesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/SmsMessagesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/SmsMessagesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/SmsMessagesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/SmsMessagesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/SmsMessagesMessageResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SmsMessagesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessagesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessagesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "SmsMessagesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/SmsMessagesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/SmsMessagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/SmsMessagesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/SmsMessagesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/SmsMessagesCreated_onResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/SmsMessagesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/SmsMessagesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/SmsMessagesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/SmsMessagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/SmsMessagesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/SmsMessagesMessageResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SmsMessagesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SmsMessagesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessagesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (smsMessages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "smsMessages" ] }, "id" : { "$ref" : "#/components/schemas/SmsMessagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessagesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/SmsMessagesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "SmsMessagesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessagesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessagesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "SmsMessagesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "smsMessageLogs" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/smsMessages/{id}/relationships/smsMessageLogs" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/smsMessages/{id}/smsMessageLogs" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SmsMessagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessagesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/smsMessages/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessagesMessageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SmsMessagesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/SmsMessagesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/SmsMessagesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/SmsMessagesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/SmsMessagesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/SmsMessagesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/SmsMessagesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/SmsMessagesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/SmsMessagesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/SmsMessagesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "message" : { "$ref" : "#/components/schemas/SmsMessagesMessageResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SmsMessagesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SmsMessagesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SmsMessagesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SmsMessagesResourcePostAttributes", "exampleSetFlag" : false } ] }, "SmsMessagesSmsMessageLogsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "StatesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (states)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "states" ] }, "id" : { "$ref" : "#/components/schemas/StatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "StatesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "country" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/states/{id}/relationships/country" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/states/{id}/country" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CountriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locations" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/states/{id}/relationships/locations" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/states/{id}/locations" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/StatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/StatesNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/StatesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "abbrev" : { "$ref" : "#/components/schemas/StatesAbbrevResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/StatesCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/StatesCountryidResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "StatesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/StatesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesCountryidResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "StatesLocationsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "StatesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/StatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/StatesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/StatesNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/StatesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "abbrev" : { "$ref" : "#/components/schemas/StatesAbbrevResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/StatesCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/StatesCountryidResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "StatesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatesResourceLinks", "exampleSetFlag" : false } ] }, "StatesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesAbbrevResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (states)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "states" ] }, "id" : { "$ref" : "#/components/schemas/StatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "StatesCountryResourceAttribute" : { "$ref" : "#/components/schemas/CountriesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "StatesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/StatesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "StatesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/states/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "StatesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StatesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatesResourcePostAttributes", "exampleSetFlag" : false } ] }, "StatesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/StatesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/StatesNameResourceAttribute", "exampleSetFlag" : false }, "abbrev" : { "$ref" : "#/components/schemas/StatesAbbrevResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/StatesCreated_byResourceAttribute", "exampleSetFlag" : false }, "countryid" : { "$ref" : "#/components/schemas/StatesCountryidResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "StatusesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (statuses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "statuses" ] }, "id" : { "$ref" : "#/components/schemas/StatusesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "StatusesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/StatusesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/StatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/StatusesCodeResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/StatusesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/StatusesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/StatusesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/StatusesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/StatusesDescriptionResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/StatusesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/StatusesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/StatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/StatusesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/StatusesCodeResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/StatusesDescriptionResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/StatusesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/StatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/StatusesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/StatusesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/StatusesCreated_onResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/StatusesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/StatusesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/StatusesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/StatusesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/StatusesAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/statuses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesEmployeeMessagesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "StatusesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "StatusesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatusesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatusesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatusesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatusesResourceLinks", "exampleSetFlag" : false } ] }, "StatusesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/StatusesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StatusesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatusesResourcePostAttributes", "exampleSetFlag" : false } ] }, "StatusesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/StatusesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/StatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/StatusesCodeResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/StatusesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/StatusesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/StatusesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/StatusesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/StatusesDescriptionResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/StatusesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/StatusesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/StatusesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/StatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/StatusesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "StatusesDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "StatusesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "StatusesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeeMessages" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/statuses/{id}/relationships/employeeMessages" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/messaging/1.0/statuses/{id}/employeeMessages" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "StatusesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (statuses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "statuses" ] }, "id" : { "$ref" : "#/components/schemas/StatusesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesCodeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesCodeRescheduleResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "StatusesCodeResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/statusesCode/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodePostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StatusesCodePostResourceReference", "exampleSetFlag" : false } ] }, "StatusesCodeNext_status_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "StatusesCodeActivitiesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "StatusesCodeCategoryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesCodePatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StatusesCodeResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodeDeletedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "StatusesCodePostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/StatusesCodePostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodeIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "StatusesCodeResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StatusesCodeResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatusesCodeResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatusesCodeResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StatusesCodeResourceLinks", "exampleSetFlag" : false } ] }, "StatusesCodeDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesCodeResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "activities" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/statusesCode/{id}/relationships/activities" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/statusesCode/{id}/activities" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodePostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesCodePostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodeNotify_excavatorResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "StatusesCodeResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (statusesCode)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "statusesCode" ] }, "id" : { "$ref" : "#/components/schemas/StatusesCodeIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodeResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesCodeResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "StatusesCodeResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/StatusesCodeResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodeResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "reschedule" : { "$ref" : "#/components/schemas/StatusesCodeRescheduleResourceAttribute", "exampleSetFlag" : false }, "notify_excavator" : { "$ref" : "#/components/schemas/StatusesCodeNotify_excavatorResourceAttribute", "exampleSetFlag" : false }, "screening" : { "$ref" : "#/components/schemas/StatusesCodeScreeningResourceAttribute", "exampleSetFlag" : false }, "code" : { "$ref" : "#/components/schemas/StatusesCodeCodeResourceAttribute", "exampleSetFlag" : false }, "deleted" : { "$ref" : "#/components/schemas/StatusesCodeDeletedResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/StatusesCodeDescriptionResourceAttribute", "exampleSetFlag" : false }, "category" : { "$ref" : "#/components/schemas/StatusesCodeCategoryResourceAttribute", "exampleSetFlag" : false }, "next_status_id" : { "$ref" : "#/components/schemas/StatusesCodeNext_status_idResourceAttribute", "exampleSetFlag" : false }, "on_site" : { "$ref" : "#/components/schemas/StatusesCodeOn_siteResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodeCodeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StatusesCodeResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StatusesCodeResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodePostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (statusesCode)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "statusesCode" ] }, "id" : { "$ref" : "#/components/schemas/StatusesCodeIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StatusesCodeScreeningResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "StatusesCodeResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/StatusesCodeResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "StatusesCodeOn_siteResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "StorageVolumesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "path" : { "$ref" : "#/components/schemas/StorageVolumesPathResourceAttribute", "exampleSetFlag" : false }, "protocol" : { "$ref" : "#/components/schemas/StorageVolumesProtocolResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/StorageVolumesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/StorageVolumesCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/StorageVolumesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/StorageVolumesActiveResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/StorageVolumesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/StorageVolumesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/StorageVolumesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/StorageVolumesApplication_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/StorageVolumesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesApplication_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "StorageVolumesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StorageVolumesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StorageVolumesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "StorageVolumesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "path" : { "$ref" : "#/components/schemas/StorageVolumesPathResourceAttribute", "exampleSetFlag" : false }, "protocol" : { "$ref" : "#/components/schemas/StorageVolumesProtocolResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/StorageVolumesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/StorageVolumesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/StorageVolumesActiveResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/StorageVolumesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/StorageVolumesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/StorageVolumesApplication_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/StorageVolumesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesProtocolResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StorageVolumesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "StorageVolumesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StorageVolumesPathResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StorageVolumesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/StorageVolumesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StorageVolumesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StorageVolumesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StorageVolumesResourcePostRelationships", "exampleSetFlag" : false } ] }, "StorageVolumesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "application" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "attachments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/storageVolumes/{id}/relationships/attachments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/storageVolumes/{id}/attachments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "application" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/storageVolumes/{id}/relationships/application" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/storageVolumes/{id}/application" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StorageVolumesActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "StorageVolumesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (storageVolumes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "storageVolumes" ] }, "id" : { "$ref" : "#/components/schemas/StorageVolumesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StorageVolumesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StorageVolumesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StorageVolumesResourceLinks", "exampleSetFlag" : false } ] }, "StorageVolumesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "StorageVolumesAttachmentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "StorageVolumesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/storageVolumes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (storageVolumes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "storageVolumes" ] }, "id" : { "$ref" : "#/components/schemas/StorageVolumesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "application" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "StorageVolumesApplicationResourceAttribute" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "StorageVolumesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/StorageVolumesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "StorageVolumesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/StorageVolumesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StorageVolumesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/StorageVolumesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/StorageVolumesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "StorageVolumesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "path" : { "$ref" : "#/components/schemas/StorageVolumesPathResourceAttribute", "exampleSetFlag" : false }, "protocol" : { "$ref" : "#/components/schemas/StorageVolumesProtocolResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/StorageVolumesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/StorageVolumesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/StorageVolumesActiveResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/StorageVolumesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/StorageVolumesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/StorageVolumesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/StorageVolumesApplication_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/StorageVolumesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "StorageVolumesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SupervisorGroupsEmployeesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "SupervisorGroupsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "SupervisorGroupsDistrict_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SupervisorGroupsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SupervisorGroupsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "SupervisorGroupsStatusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SupervisorGroupsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "SupervisorGroupsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SupervisorGroupsResourceLinks", "exampleSetFlag" : false } ] }, "SupervisorGroupsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/SupervisorGroupsDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "district_code" : { "$ref" : "#/components/schemas/SupervisorGroupsDistrict_codeResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/SupervisorGroupsRegionResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/SupervisorGroupsSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SupervisorGroupsCreated_byResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/SupervisorGroupsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "SupervisorGroupsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/SupervisorGroupsDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/SupervisorGroupsCreated_onResourceAttribute", "exampleSetFlag" : false }, "district_code" : { "$ref" : "#/components/schemas/SupervisorGroupsDistrict_codeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/SupervisorGroupsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/SupervisorGroupsRegionResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/SupervisorGroupsSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SupervisorGroupsCreated_byResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/SupervisorGroupsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsDistResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : false, "exampleSetFlag" : false }, "SupervisorGroupsAssetsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "SupervisorGroupsEmployeesActiveNoAssetResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "SupervisorGroupsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/SupervisorGroupsDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "district_code" : { "$ref" : "#/components/schemas/SupervisorGroupsDistrict_codeResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/SupervisorGroupsRegionResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/SupervisorGroupsSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/SupervisorGroupsCreated_byResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/SupervisorGroupsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SupervisorGroupsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SupervisorGroupsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/SupervisorGroupsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/SupervisorGroupsResourcePostAttributes", "exampleSetFlag" : false } ] }, "SupervisorGroupsEmployeesOnLoanResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "SupervisorGroupsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (supervisorGroups)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "supervisorGroups" ] }, "id" : { "$ref" : "#/components/schemas/SupervisorGroupsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (supervisorGroups)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "supervisorGroups" ] }, "id" : { "$ref" : "#/components/schemas/SupervisorGroupsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsSup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "SupervisorGroupsDistrict_codeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "SupervisorGroupsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "assets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/relationships/assets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/assets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesActiveNoAsset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/relationships/employeesActiveNoAsset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/employeesActiveNoAsset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/relationships/dist" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/dist" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employees" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/relationships/employees" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/employees" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesOnLoan" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/relationships/employeesOnLoan" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/supervisorGroups/{id}/employeesOnLoan" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/SupervisorGroupsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "SupervisorGroupsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TermUtilityMapsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TermUtilityMapsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TermUtilityMapsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (termUtilityMaps)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "termUtilityMaps" ] }, "id" : { "$ref" : "#/components/schemas/TermUtilityMapsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermUtilityMapsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "utility_id" : { "$ref" : "#/components/schemas/TermUtilityMapsUtility_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "locate" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/termUtilityMaps/{id}/relationships/locate" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/termUtilityMaps/{id}/locate" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locateClosedSnapshot" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/termUtilityMaps/{id}/relationships/locateClosedSnapshot" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/termUtilityMaps/{id}/locateClosedSnapshot" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locateOpenSnapshot" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/termUtilityMaps/{id}/relationships/locateOpenSnapshot" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/termUtilityMaps/{id}/locateOpenSnapshot" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TermUtilityMapsPostResourceReference", "exampleSetFlag" : false } ] }, "TermUtilityMapsUtility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TermUtilityMapsLocateResourceAttribute" : { "$ref" : "#/components/schemas/LocatesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TermUtilityMapsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TermUtilityMapsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/termUtilityMaps/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsLocateOpenSnapshotResourceAttribute" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TermUtilityMapsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (termUtilityMaps)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "termUtilityMaps" ] }, "id" : { "$ref" : "#/components/schemas/TermUtilityMapsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TermUtilityMapsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermUtilityMapsLocateClosedSnapshotResourceAttribute" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TermUtilityMapsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TermUtilityMapsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TermUtilityMapsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TermUtilityMapsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TermUtilityMapsResourceLinks", "exampleSetFlag" : false } ] }, "TermsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TermsLocatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TermsParseResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TermsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TermsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TermsDo_not_respondResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TermsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TermsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsRespond_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TermsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TermsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TermsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TermsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TermsResourceLinks", "exampleSetFlag" : false } ] }, "TermsDo_not_closeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TermsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "code" : { "$ref" : "#/components/schemas/TermsCodeResourceAttribute", "exampleSetFlag" : false }, "do_not_respond" : { "$ref" : "#/components/schemas/TermsDo_not_respondResourceAttribute", "exampleSetFlag" : false }, "unlocatable_term_id" : { "$ref" : "#/components/schemas/TermsUnlocatable_term_idResourceAttribute", "exampleSetFlag" : false }, "add_text_only" : { "$ref" : "#/components/schemas/TermsAdd_text_onlyResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/TermsDescriptionResourceAttribute", "exampleSetFlag" : false }, "charge_once" : { "$ref" : "#/components/schemas/TermsCharge_onceResourceAttribute", "exampleSetFlag" : false }, "create_audit_item" : { "$ref" : "#/components/schemas/TermsCreate_audit_itemResourceAttribute", "exampleSetFlag" : false }, "parse" : { "$ref" : "#/components/schemas/TermsParseResourceAttribute", "exampleSetFlag" : false }, "unlocatable_status_id" : { "$ref" : "#/components/schemas/TermsUnlocatable_status_idResourceAttribute", "exampleSetFlag" : false }, "feed_id" : { "$ref" : "#/components/schemas/TermsFeed_idResourceAttribute", "exampleSetFlag" : false }, "inactive" : { "$ref" : "#/components/schemas/TermsInactiveResourceAttribute", "exampleSetFlag" : false }, "respond_code" : { "$ref" : "#/components/schemas/TermsRespond_codeResourceAttribute", "exampleSetFlag" : false }, "do_not_close" : { "$ref" : "#/components/schemas/TermsDo_not_closeResourceAttribute", "exampleSetFlag" : false }, "read_from_members" : { "$ref" : "#/components/schemas/TermsRead_from_membersResourceAttribute", "exampleSetFlag" : false }, "read_from_master_code" : { "$ref" : "#/components/schemas/TermsRead_from_master_codeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsInactiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TermsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TermsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TermsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsUnlocatable_status_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TermsRead_from_master_codeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TermsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (terms)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "terms" ] }, "id" : { "$ref" : "#/components/schemas/TermsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsLocateClosedSnapshotsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TermsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/terms/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsAdd_text_onlyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TermsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (terms)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "terms" ] }, "id" : { "$ref" : "#/components/schemas/TermsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TermsUnlocatable_term_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TermsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TermsPostResourceReference", "exampleSetFlag" : false } ] }, "TermsLocateOpenSnapshotsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TermsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "feed" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/terms/{id}/relationships/feed" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/terms/{id}/feed" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locateOpenSnapshots" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/terms/{id}/relationships/locateOpenSnapshots" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/terms/{id}/locateOpenSnapshots" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/terms/{id}/relationships/locates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/terms/{id}/locates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locateClosedSnapshots" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/terms/{id}/relationships/locateClosedSnapshots" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/terms/{id}/locateClosedSnapshots" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TermsCodeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TermsCreate_audit_itemResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TermsFeed_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TermsFeedResourceAttribute" : { "$ref" : "#/components/schemas/FeedsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TermsCharge_onceResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TermsRead_from_membersResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketClosedsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TicketClosedsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TicketClosedsLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TicketClosedsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ticketCloseds)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ticketCloseds" ] }, "id" : { "$ref" : "#/components/schemas/TicketClosedsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsLocatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketClosedsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketClosedsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketClosedsResourceLinks", "exampleSetFlag" : false } ] }, "TicketClosedsLocator_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsStreetnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsTransmissionResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TicketClosedsClosed_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsUtilityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/TicketClosedsAccount_numberResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/TicketClosedsClosed_dateResourceAttribute", "exampleSetFlag" : false }, "transmit_date" : { "$ref" : "#/components/schemas/TicketClosedsTransmit_dateResourceAttribute", "exampleSetFlag" : false }, "streetname" : { "$ref" : "#/components/schemas/TicketClosedsStreetnameResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/TicketClosedsCityResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/TicketClosedsCountyResourceAttribute", "exampleSetFlag" : false }, "utility" : { "$ref" : "#/components/schemas/TicketClosedsUtilityResourceAttribute", "exampleSetFlag" : false }, "project" : { "$ref" : "#/components/schemas/TicketClosedsProjectResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/TicketClosedsLonResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/TicketClosedsExcavatorResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/TicketClosedsContract_numberResourceAttribute", "exampleSetFlag" : false }, "locator_id" : { "$ref" : "#/components/schemas/TicketClosedsLocator_idResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/TicketClosedsStateResourceAttribute", "exampleSetFlag" : false }, "transmission_id" : { "$ref" : "#/components/schemas/TicketClosedsTransmission_idResourceAttribute", "exampleSetFlag" : false }, "tickettype" : { "$ref" : "#/components/schemas/TicketClosedsTickettypeResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/TicketClosedsLatResourceAttribute", "exampleSetFlag" : false }, "work_date" : { "$ref" : "#/components/schemas/TicketClosedsWork_dateResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/TicketClosedsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/TicketClosedsTicket_idResourceAttribute", "exampleSetFlag" : false }, "street_number" : { "$ref" : "#/components/schemas/TicketClosedsStreet_numberResourceAttribute", "exampleSetFlag" : false }, "our_due_date" : { "$ref" : "#/components/schemas/TicketClosedsOur_due_dateResourceAttribute", "exampleSetFlag" : false }, "high_profile" : { "$ref" : "#/components/schemas/TicketClosedsHigh_profileResourceAttribute", "exampleSetFlag" : false }, "locator" : { "$ref" : "#/components/schemas/TicketClosedsLocatorResourceAttribute", "exampleSetFlag" : false }, "supervisor" : { "$ref" : "#/components/schemas/TicketClosedsSupervisorResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/TicketClosedsStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsWork_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsTransmit_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsSupervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketClosedsPostResourceReference", "exampleSetFlag" : false } ] }, "TicketClosedsStreet_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsHigh_profileResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsExcavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketClosedsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "transmission" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/tickets/closed/{id}/relationships/transmission" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/tickets/closed/{id}/transmission" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/tickets/closed/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/tickets/closed/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionBase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/tickets/closed/{id}/relationships/transmissionBase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/tickets/closed/{id}/transmissionBase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketClosedsAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TicketClosedsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TicketClosedsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsContract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsTransmissionBaseResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TicketClosedsOur_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsStatusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TicketClosedsProjectResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsTickettypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketClosedsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/tickets/closed/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ticketCloseds)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ticketCloseds" ] }, "id" : { "$ref" : "#/components/schemas/TicketClosedsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TicketClosedsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketClosedsTransmission_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketRequestedServicesHigh_priorityResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketRequestedServicesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketRequestedServicesPostResourceReference", "exampleSetFlag" : false } ] }, "TicketRequestedServicesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketRequestedServicesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TicketRequestedServicesTkpTicketResourceAttribute" : { "$ref" : "#/components/schemas/TkpTicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TicketRequestedServicesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "assigned_by_rule_id" : { "$ref" : "#/components/schemas/TicketRequestedServicesAssigned_by_rule_idResourceAttribute", "exampleSetFlag" : false }, "service_type" : { "$ref" : "#/components/schemas/TicketRequestedServicesService_typeResourceAttribute", "exampleSetFlag" : false }, "requested_service_date" : { "$ref" : "#/components/schemas/TicketRequestedServicesRequested_service_dateResourceAttribute", "exampleSetFlag" : false }, "tkpTicket" : { "$ref" : "#/components/schemas/TicketRequestedServicesTkpTicketResourceAttribute", "exampleSetFlag" : false }, "bore_footage" : { "$ref" : "#/components/schemas/TicketRequestedServicesBore_footageResourceAttribute", "exampleSetFlag" : false }, "service_id" : { "$ref" : "#/components/schemas/TicketRequestedServicesService_idResourceAttribute", "exampleSetFlag" : false }, "assigned_by_user_id" : { "$ref" : "#/components/schemas/TicketRequestedServicesAssigned_by_user_idResourceAttribute", "exampleSetFlag" : false }, "created_date" : { "$ref" : "#/components/schemas/TicketRequestedServicesCreated_dateResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/TicketRequestedServicesTicket_idResourceAttribute", "exampleSetFlag" : false }, "assigned_by_external_user" : { "$ref" : "#/components/schemas/TicketRequestedServicesAssigned_by_external_userResourceAttribute", "exampleSetFlag" : false }, "modified_date" : { "$ref" : "#/components/schemas/TicketRequestedServicesModified_dateResourceAttribute", "exampleSetFlag" : false }, "high_priority" : { "$ref" : "#/components/schemas/TicketRequestedServicesHigh_priorityResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketRequestedServicesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ticketRequestedServices)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ticketRequestedServices" ] }, "id" : { "$ref" : "#/components/schemas/TicketRequestedServicesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketRequestedServicesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketRequestedServicesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketRequestedServicesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketRequestedServicesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketRequestedServicesService_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketRequestedServicesAssigned_by_user_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketRequestedServicesTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketRequestedServicesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketRequestedServicesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketRequestedServicesCreated_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketRequestedServicesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TicketRequestedServicesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketRequestedServicesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketRequestedServicesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketRequestedServicesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketRequestedServicesResourceLinks", "exampleSetFlag" : false } ] }, "TicketRequestedServicesBore_footageResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketRequestedServicesModified_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketRequestedServicesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ticketRequestedServices)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ticketRequestedServices" ] }, "id" : { "$ref" : "#/components/schemas/TicketRequestedServicesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketRequestedServicesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TicketRequestedServicesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketRequestedServicesService_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketRequestedServicesAssigned_by_external_userResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketRequestedServicesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/ticketRequestedServices/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketRequestedServicesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TicketRequestedServicesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TicketRequestedServicesRequested_service_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketRequestedServicesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketRequestedServicesAssigned_by_rule_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsProjectTicketResourceAttribute" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TicketsLinkedTicketsResourceAttribute" : { "uniqueItems" : false, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "type" : "object", "exampleSetFlag" : false, "types" : [ "object" ] }, "types" : [ "array" ] }, "TicketsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TicketsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TicketsBill_to_contact_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsOpenResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsCpClosedTicketsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TicketsOur_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsLocatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TicketsTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsTicket_sup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsVisitsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TicketsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "dueDateExtensions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/dueDateExtensions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/dueDateExtensions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ticketsInfo" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/ticketsInfo" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/ticketsInfo" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsInfoResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsInfoResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "tkpAttachmentsWithNotifications" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/tkpAttachmentsWithNotifications" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/tkpAttachmentsWithNotifications" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentsCategorized" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/attachmentsCategorized" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/attachmentsCategorized" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/locates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/locates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/transmissionDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/transmissionDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionBase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/transmissionBase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/transmissionBase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "tkpAttachments" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/tkpAttachments" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/tkpAttachments" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "tkpDistrict" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/tkpDistrict" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/tkpDistrict" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "projectTicket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/projectTicket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/projectTicket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ProjectTicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "visits" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/visits" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/visits" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmission" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/transmission" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/transmission" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cpClosedTickets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/cpClosedTickets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/cpClosedTickets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "activityPathPoints" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/relationships/activityPathPoints" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}/activityPathPoints" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketsResourcePostAttributes", "exampleSetFlag" : false } ] }, "TicketsTicket_invoice_signature_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsExcavator_contact_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "bill_to_contact_id" : { "$ref" : "#/components/schemas/TicketsBill_to_contact_idResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/TicketsClosed_dateResourceAttribute", "exampleSetFlag" : false }, "billed_manually" : { "$ref" : "#/components/schemas/TicketsBilled_manuallyResourceAttribute", "exampleSetFlag" : false }, "latest_transmission_id" : { "$ref" : "#/components/schemas/TicketsLatest_transmission_idResourceAttribute", "exampleSetFlag" : false }, "excavator_contact_id" : { "$ref" : "#/components/schemas/TicketsExcavator_contact_idResourceAttribute", "exampleSetFlag" : false }, "linkedTickets" : { "$ref" : "#/components/schemas/TicketsLinkedTicketsResourceAttribute", "exampleSetFlag" : false }, "risk_score" : { "$ref" : "#/components/schemas/TicketsRisk_scoreResourceAttribute", "exampleSetFlag" : false }, "locate_list_cache" : { "$ref" : "#/components/schemas/TicketsLocate_list_cacheResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/TicketsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "ticket_district_id" : { "$ref" : "#/components/schemas/TicketsTicket_district_idResourceAttribute", "exampleSetFlag" : false }, "ticket_contact_id" : { "$ref" : "#/components/schemas/TicketsTicket_contact_idResourceAttribute", "exampleSetFlag" : false }, "ticket_sup_group_id" : { "$ref" : "#/components/schemas/TicketsTicket_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "ordered_by_contact_id" : { "$ref" : "#/components/schemas/TicketsOrdered_by_contact_idResourceAttribute", "exampleSetFlag" : false }, "our_due_date" : { "$ref" : "#/components/schemas/TicketsOur_due_dateResourceAttribute", "exampleSetFlag" : false }, "ticket_invoice_signature_id" : { "$ref" : "#/components/schemas/TicketsTicket_invoice_signature_idResourceAttribute", "exampleSetFlag" : false }, "open" : { "$ref" : "#/components/schemas/TicketsOpenResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsClosed_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsTkpDistrictResourceAttribute" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TicketsLocate_list_cacheResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tickets" ] }, "id" : { "$ref" : "#/components/schemas/TicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tickets" ] }, "id" : { "$ref" : "#/components/schemas/TicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "bill_to_contact_id" : { "$ref" : "#/components/schemas/TicketsBill_to_contact_idResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/TicketsClosed_dateResourceAttribute", "exampleSetFlag" : false }, "billed_manually" : { "$ref" : "#/components/schemas/TicketsBilled_manuallyResourceAttribute", "exampleSetFlag" : false }, "latest_transmission_id" : { "$ref" : "#/components/schemas/TicketsLatest_transmission_idResourceAttribute", "exampleSetFlag" : false }, "excavator_contact_id" : { "$ref" : "#/components/schemas/TicketsExcavator_contact_idResourceAttribute", "exampleSetFlag" : false }, "linkedTickets" : { "$ref" : "#/components/schemas/TicketsLinkedTicketsResourceAttribute", "exampleSetFlag" : false }, "risk_score" : { "$ref" : "#/components/schemas/TicketsRisk_scoreResourceAttribute", "exampleSetFlag" : false }, "locate_list_cache" : { "$ref" : "#/components/schemas/TicketsLocate_list_cacheResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/TicketsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "ticket_district_id" : { "$ref" : "#/components/schemas/TicketsTicket_district_idResourceAttribute", "exampleSetFlag" : false }, "ticket_contact_id" : { "$ref" : "#/components/schemas/TicketsTicket_contact_idResourceAttribute", "exampleSetFlag" : false }, "ticket_sup_group_id" : { "$ref" : "#/components/schemas/TicketsTicket_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "ordered_by_contact_id" : { "$ref" : "#/components/schemas/TicketsOrdered_by_contact_idResourceAttribute", "exampleSetFlag" : false }, "our_due_date" : { "$ref" : "#/components/schemas/TicketsOur_due_dateResourceAttribute", "exampleSetFlag" : false }, "ticket_invoice_signature_id" : { "$ref" : "#/components/schemas/TicketsTicket_invoice_signature_idResourceAttribute", "exampleSetFlag" : false }, "open" : { "$ref" : "#/components/schemas/TicketsOpenResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsAttachmentsCategorizedResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TicketsTicket_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsTicketsInfoResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsInfoResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TicketsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsDueDateExtensionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TicketsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TicketsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsTransmissionBaseResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TicketsOpen_emergencyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsTransmissionResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TicketsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/tickets/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsTkpAttachmentsWithNotificationsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TicketsTransmissionDetailResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TicketsLatest_transmission_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsBilled_manuallyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsTicket_contact_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsTkpAttachmentsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TicketsRisk_scoreResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TicketsActivityPathPointsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TicketsOrdered_by_contact_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TicketsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "bill_to_contact_id" : { "$ref" : "#/components/schemas/TicketsBill_to_contact_idResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/TicketsClosed_dateResourceAttribute", "exampleSetFlag" : false }, "billed_manually" : { "$ref" : "#/components/schemas/TicketsBilled_manuallyResourceAttribute", "exampleSetFlag" : false }, "latest_transmission_id" : { "$ref" : "#/components/schemas/TicketsLatest_transmission_idResourceAttribute", "exampleSetFlag" : false }, "excavator_contact_id" : { "$ref" : "#/components/schemas/TicketsExcavator_contact_idResourceAttribute", "exampleSetFlag" : false }, "linkedTickets" : { "$ref" : "#/components/schemas/TicketsLinkedTicketsResourceAttribute", "exampleSetFlag" : false }, "risk_score" : { "$ref" : "#/components/schemas/TicketsRisk_scoreResourceAttribute", "exampleSetFlag" : false }, "locate_list_cache" : { "$ref" : "#/components/schemas/TicketsLocate_list_cacheResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/TicketsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "open_emergency" : { "$ref" : "#/components/schemas/TicketsOpen_emergencyResourceAttribute", "exampleSetFlag" : false }, "ticket_district_id" : { "$ref" : "#/components/schemas/TicketsTicket_district_idResourceAttribute", "exampleSetFlag" : false }, "ticket_contact_id" : { "$ref" : "#/components/schemas/TicketsTicket_contact_idResourceAttribute", "exampleSetFlag" : false }, "ticket_sup_group_id" : { "$ref" : "#/components/schemas/TicketsTicket_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "ordered_by_contact_id" : { "$ref" : "#/components/schemas/TicketsOrdered_by_contact_idResourceAttribute", "exampleSetFlag" : false }, "our_due_date" : { "$ref" : "#/components/schemas/TicketsOur_due_dateResourceAttribute", "exampleSetFlag" : false }, "ticket_invoice_signature_id" : { "$ref" : "#/components/schemas/TicketsTicket_invoice_signature_idResourceAttribute", "exampleSetFlag" : false }, "open" : { "$ref" : "#/components/schemas/TicketsOpenResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketsResourceLinks", "exampleSetFlag" : false } ] }, "TicketsInfoResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsInfoResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TicketsInfoResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TicketsInfoPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ticketsInfo)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ticketsInfo" ] }, "id" : { "$ref" : "#/components/schemas/TicketsInfoIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketsInfoResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketsInfoResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketsInfoResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TicketsInfoResourceLinks", "exampleSetFlag" : false } ] }, "TicketsInfoPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketsInfoResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoEmergencyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsInfoResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "rms_cn_deferred" : { "$ref" : "#/components/schemas/TicketsInfoRms_cn_deferredResourceAttribute", "exampleSetFlag" : false }, "expires_date" : { "$ref" : "#/components/schemas/TicketsInfoExpires_dateResourceAttribute", "exampleSetFlag" : false }, "emergency" : { "$ref" : "#/components/schemas/TicketsInfoEmergencyResourceAttribute", "exampleSetFlag" : false }, "lot_ownership" : { "$ref" : "#/components/schemas/TicketsInfoLot_ownershipResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/TicketsInfoTicket_idResourceAttribute", "exampleSetFlag" : false }, "area_id" : { "$ref" : "#/components/schemas/TicketsInfoArea_idResourceAttribute", "exampleSetFlag" : false }, "meet_date" : { "$ref" : "#/components/schemas/TicketsInfoMeet_dateResourceAttribute", "exampleSetFlag" : false }, "eta" : { "$ref" : "#/components/schemas/TicketsInfoEtaResourceAttribute", "exampleSetFlag" : false }, "rms_eet_assigned" : { "$ref" : "#/components/schemas/TicketsInfoRms_eet_assignedResourceAttribute", "exampleSetFlag" : false }, "meet" : { "$ref" : "#/components/schemas/TicketsInfoMeetResourceAttribute", "exampleSetFlag" : false }, "work_time_type" : { "$ref" : "#/components/schemas/TicketsInfoWork_time_typeResourceAttribute", "exampleSetFlag" : false }, "rms_cn_map_sent" : { "$ref" : "#/components/schemas/TicketsInfoRms_cn_map_sentResourceAttribute", "exampleSetFlag" : false }, "added_by_id" : { "$ref" : "#/components/schemas/TicketsInfoAdded_by_idResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/TicketsInfoEffective_dateResourceAttribute", "exampleSetFlag" : false }, "sup_cn_reviewed" : { "$ref" : "#/components/schemas/TicketsInfoSup_cn_reviewedResourceAttribute", "exampleSetFlag" : false }, "master_contractor" : { "$ref" : "#/components/schemas/TicketsInfoMaster_contractorResourceAttribute", "exampleSetFlag" : false }, "rms_cn_reviewed" : { "$ref" : "#/components/schemas/TicketsInfoRms_cn_reviewedResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/TicketsInfoRegionResourceAttribute", "exampleSetFlag" : false }, "lot_type" : { "$ref" : "#/components/schemas/TicketsInfoLot_typeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/ticketsInfo/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TicketsInfoPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoSup_cn_reviewedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsInfoMaster_contractorResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsInfoRms_cn_reviewedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsInfoPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsInfoPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoEtaResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsInfoWork_time_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsInfoResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/ticketsInfo/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/ticketsInfo/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (ticketsInfo)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "ticketsInfo" ] }, "id" : { "$ref" : "#/components/schemas/TicketsInfoIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TicketsInfoPostResourceReference", "exampleSetFlag" : false } ] }, "TicketsInfoRms_cn_deferredResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsInfoIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsInfoLot_ownershipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsInfoExpires_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsInfoResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TicketsInfoResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TicketsInfoMeetResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsInfoMeet_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsInfoRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsInfoRms_cn_map_sentResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsInfoRms_eet_assignedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TicketsInfoArea_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsInfoResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsInfoResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TicketsInfoLot_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsInfoAdded_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsInfoTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TicketsInfoEffective_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TicketsInfoTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TkpAttachmentPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentHashResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentStatusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentAttachmentTagResourceAttribute" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TkpAttachmentTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TkpAttachmentResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "original_ticket_number" : { "$ref" : "#/components/schemas/TkpAttachmentOriginal_ticket_numberResourceAttribute", "exampleSetFlag" : false }, "created_time" : { "$ref" : "#/components/schemas/TkpAttachmentCreated_timeResourceAttribute", "exampleSetFlag" : false }, "file_name" : { "$ref" : "#/components/schemas/TkpAttachmentFile_nameResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/TkpAttachmentLonResourceAttribute", "exampleSetFlag" : false }, "entity_id" : { "$ref" : "#/components/schemas/TkpAttachmentEntity_idResourceAttribute", "exampleSetFlag" : false }, "file_size" : { "$ref" : "#/components/schemas/TkpAttachmentFile_sizeResourceAttribute", "exampleSetFlag" : false }, "attached_by" : { "$ref" : "#/components/schemas/TkpAttachmentAttached_byResourceAttribute", "exampleSetFlag" : false }, "entity_kind" : { "$ref" : "#/components/schemas/TkpAttachmentEntity_kindResourceAttribute", "exampleSetFlag" : false }, "attachment_type" : { "$ref" : "#/components/schemas/TkpAttachmentAttachment_typeResourceAttribute", "exampleSetFlag" : false }, "when_attached" : { "$ref" : "#/components/schemas/TkpAttachmentWhen_attachedResourceAttribute", "exampleSetFlag" : false }, "attachment_id" : { "$ref" : "#/components/schemas/TkpAttachmentAttachment_idResourceAttribute", "exampleSetFlag" : false }, "created_date" : { "$ref" : "#/components/schemas/TkpAttachmentCreated_dateResourceAttribute", "exampleSetFlag" : false }, "hash" : { "$ref" : "#/components/schemas/TkpAttachmentHashResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/TkpAttachmentLatResourceAttribute", "exampleSetFlag" : false }, "when_uploaded" : { "$ref" : "#/components/schemas/TkpAttachmentWhen_uploadedResourceAttribute", "exampleSetFlag" : false }, "status" : { "$ref" : "#/components/schemas/TkpAttachmentStatusResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpAttachmentResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentEntity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TkpAttachmentIdResourceAttribute" : { "type" : "object", "properties" : { "attachment_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "entity_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentOriginal_ticket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpAttachmentResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpAttachmentResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpAttachmentResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpAttachmentResourceLinks", "exampleSetFlag" : false } ] }, "TkpAttachmentResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentAttachment_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TkpAttachmentPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpAttachmentPostResourceReference", "exampleSetFlag" : false } ] }, "TkpAttachmentResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TkpAttachmentResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TkpAttachmentCreated_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentCreated_timeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentWhen_attachedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachments/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentFile_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpAttachment)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpAttachment" ] }, "id" : { "$ref" : "#/components/schemas/TkpAttachmentIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpAttachmentResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentEntity_kindResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentFile_sizeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpAttachmentPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentAttachment_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentAttached_byResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentWhen_uploadedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpAttachment)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpAttachment" ] }, "id" : { "$ref" : "#/components/schemas/TkpAttachmentIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachments/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachments/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "attachmentTag" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachments/{id}/relationships/attachmentTag" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachments/{id}/attachmentTag" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TkpAttachmentTagsRespondResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TkpAttachmentTagsInfra_pedestal_smallResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsExtra_whiteliningResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsRoad_crosswalkResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsNearby_gasResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsScene_trash_boxResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsRoad_curb_yellowResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsFlags_electricResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_utility_hookupResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_hvacResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsRoad_line_blueResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_gravelResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsRoad_line_yellowResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_electric_wiresResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsWeather_dryResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsEquip_conesResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsQueued_atResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentTagsNearby_telecomResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsScene_protective_fenceResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsType_cityResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsScene_humanResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsWeather_darkResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsUtility_telecomResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_meter_waterResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsNearby_sewerResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGeomResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentTagsType_constructionResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpAttachmentTags)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpAttachmentTags" ] }, "id" : { "$ref" : "#/components/schemas/TkpAttachmentTagsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentTagsInfra_guy_wireResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentTagsInfra_bollardResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsUtility_waterResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsUtility_sewerResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_pedestal_largeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_concreteResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsEquip_constructionResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsType_residentialResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsExtra_survey_pinkResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_fallen_leavesResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsRoad_curb_whiteResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsClear_waterResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_grassResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsExtra_damageResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsClear_telecomResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_cable_debrisResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TkpAttachmentTagsRoad_curb_redResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TkpAttachmentTagsUtility_electricResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsCreated_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentTagsRoad_line_whiteResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_dirtResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsScene_caution_tapeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_construction_mudResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsCreated_timeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpAttachmentTagsPostResourceReference", "exampleSetFlag" : false } ] }, "TkpAttachmentTagsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentTagsWeather_snowResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_asphaltResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsWeather_rainResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentTagsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentTagsFlags_gasResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsFormatResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentTagsScene_screenshotResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_pipeline_polesResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsRoad_line_redResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TkpAttachmentTagsInfra_meter_electricResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_manholeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsType_commercialResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsType_ruralResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsUser_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsEquip_usic_truckResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsType_roadwayResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_mulchResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsClear_sewerResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsNearby_electricResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_paversResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_fire_hydrantResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TkpAttachmentTagsGround_dry_grassResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsFlags_waterResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsInfra_meter_gasResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "road_line_blue" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRoad_line_blueResourceAttribute", "exampleSetFlag" : false }, "ground_mulch" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_mulchResourceAttribute", "exampleSetFlag" : false }, "flags_electric" : { "$ref" : "#/components/schemas/TkpAttachmentTagsFlags_electricResourceAttribute", "exampleSetFlag" : false }, "infra_cable_debris" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_cable_debrisResourceAttribute", "exampleSetFlag" : false }, "weather_snow" : { "$ref" : "#/components/schemas/TkpAttachmentTagsWeather_snowResourceAttribute", "exampleSetFlag" : false }, "utility_telecom" : { "$ref" : "#/components/schemas/TkpAttachmentTagsUtility_telecomResourceAttribute", "exampleSetFlag" : false }, "road_curb_yellow" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRoad_curb_yellowResourceAttribute", "exampleSetFlag" : false }, "clear_sewer" : { "$ref" : "#/components/schemas/TkpAttachmentTagsClear_sewerResourceAttribute", "exampleSetFlag" : false }, "extra_damage" : { "$ref" : "#/components/schemas/TkpAttachmentTagsExtra_damageResourceAttribute", "exampleSetFlag" : false }, "weather_dark" : { "$ref" : "#/components/schemas/TkpAttachmentTagsWeather_darkResourceAttribute", "exampleSetFlag" : false }, "infra_hvac" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_hvacResourceAttribute", "exampleSetFlag" : false }, "utility_sewer" : { "$ref" : "#/components/schemas/TkpAttachmentTagsUtility_sewerResourceAttribute", "exampleSetFlag" : false }, "geom" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGeomResourceAttribute", "exampleSetFlag" : false }, "nearby_sewer" : { "$ref" : "#/components/schemas/TkpAttachmentTagsNearby_sewerResourceAttribute", "exampleSetFlag" : false }, "clear_electric" : { "$ref" : "#/components/schemas/TkpAttachmentTagsClear_electricResourceAttribute", "exampleSetFlag" : false }, "weather_rain" : { "$ref" : "#/components/schemas/TkpAttachmentTagsWeather_rainResourceAttribute", "exampleSetFlag" : false }, "type_residential" : { "$ref" : "#/components/schemas/TkpAttachmentTagsType_residentialResourceAttribute", "exampleSetFlag" : false }, "utility_gas" : { "$ref" : "#/components/schemas/TkpAttachmentTagsUtility_gasResourceAttribute", "exampleSetFlag" : false }, "ground_concrete" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_concreteResourceAttribute", "exampleSetFlag" : false }, "infra_pedestal_large" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_pedestal_largeResourceAttribute", "exampleSetFlag" : false }, "infra_meter_electric" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_meter_electricResourceAttribute", "exampleSetFlag" : false }, "infra_manhole" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_manholeResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/TkpAttachmentTagsLatResourceAttribute", "exampleSetFlag" : false }, "created_time" : { "$ref" : "#/components/schemas/TkpAttachmentTagsCreated_timeResourceAttribute", "exampleSetFlag" : false }, "infra_bollard" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_bollardResourceAttribute", "exampleSetFlag" : false }, "clear_gas" : { "$ref" : "#/components/schemas/TkpAttachmentTagsClear_gasResourceAttribute", "exampleSetFlag" : false }, "infra_pedestal_small" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_pedestal_smallResourceAttribute", "exampleSetFlag" : false }, "equip_cones" : { "$ref" : "#/components/schemas/TkpAttachmentTagsEquip_conesResourceAttribute", "exampleSetFlag" : false }, "queued_at" : { "$ref" : "#/components/schemas/TkpAttachmentTagsQueued_atResourceAttribute", "exampleSetFlag" : false }, "type_construction" : { "$ref" : "#/components/schemas/TkpAttachmentTagsType_constructionResourceAttribute", "exampleSetFlag" : false }, "clear_telecom" : { "$ref" : "#/components/schemas/TkpAttachmentTagsClear_telecomResourceAttribute", "exampleSetFlag" : false }, "type_rural" : { "$ref" : "#/components/schemas/TkpAttachmentTagsType_ruralResourceAttribute", "exampleSetFlag" : false }, "format" : { "$ref" : "#/components/schemas/TkpAttachmentTagsFormatResourceAttribute", "exampleSetFlag" : false }, "scene_screenshot" : { "$ref" : "#/components/schemas/TkpAttachmentTagsScene_screenshotResourceAttribute", "exampleSetFlag" : false }, "flags_telecom" : { "$ref" : "#/components/schemas/TkpAttachmentTagsFlags_telecomResourceAttribute", "exampleSetFlag" : false }, "infra_garden_hose" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_garden_hoseResourceAttribute", "exampleSetFlag" : false }, "ground_gravel" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_gravelResourceAttribute", "exampleSetFlag" : false }, "nearby_telecom" : { "$ref" : "#/components/schemas/TkpAttachmentTagsNearby_telecomResourceAttribute", "exampleSetFlag" : false }, "ground_construction_mud" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_construction_mudResourceAttribute", "exampleSetFlag" : false }, "scene_protective_fence" : { "$ref" : "#/components/schemas/TkpAttachmentTagsScene_protective_fenceResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/TkpAttachmentTagsUser_idResourceAttribute", "exampleSetFlag" : false }, "flags_sewer" : { "$ref" : "#/components/schemas/TkpAttachmentTagsFlags_sewerResourceAttribute", "exampleSetFlag" : false }, "road_curb_red" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRoad_curb_redResourceAttribute", "exampleSetFlag" : false }, "clear_water" : { "$ref" : "#/components/schemas/TkpAttachmentTagsClear_waterResourceAttribute", "exampleSetFlag" : false }, "scene_caution_tape" : { "$ref" : "#/components/schemas/TkpAttachmentTagsScene_caution_tapeResourceAttribute", "exampleSetFlag" : false }, "flags_water" : { "$ref" : "#/components/schemas/TkpAttachmentTagsFlags_waterResourceAttribute", "exampleSetFlag" : false }, "type_city" : { "$ref" : "#/components/schemas/TkpAttachmentTagsType_cityResourceAttribute", "exampleSetFlag" : false }, "type_commercial" : { "$ref" : "#/components/schemas/TkpAttachmentTagsType_commercialResourceAttribute", "exampleSetFlag" : false }, "type_new_homes" : { "$ref" : "#/components/schemas/TkpAttachmentTagsType_new_homesResourceAttribute", "exampleSetFlag" : false }, "road_line_yellow" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRoad_line_yellowResourceAttribute", "exampleSetFlag" : false }, "ground_dry_grass" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_dry_grassResourceAttribute", "exampleSetFlag" : false }, "ground_asphalt" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_asphaltResourceAttribute", "exampleSetFlag" : false }, "infra_pipeline_poles" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_pipeline_polesResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/TkpAttachmentTagsLonResourceAttribute", "exampleSetFlag" : false }, "infra_fire_hydrant" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_fire_hydrantResourceAttribute", "exampleSetFlag" : false }, "scene_trash_box" : { "$ref" : "#/components/schemas/TkpAttachmentTagsScene_trash_boxResourceAttribute", "exampleSetFlag" : false }, "infra_guy_wire" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_guy_wireResourceAttribute", "exampleSetFlag" : false }, "processed_at" : { "$ref" : "#/components/schemas/TkpAttachmentTagsProcessed_atResourceAttribute", "exampleSetFlag" : false }, "infra_meter_water" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_meter_waterResourceAttribute", "exampleSetFlag" : false }, "ground_fallen_leaves" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_fallen_leavesResourceAttribute", "exampleSetFlag" : false }, "road_line_white" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRoad_line_whiteResourceAttribute", "exampleSetFlag" : false }, "ground_pavers" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_paversResourceAttribute", "exampleSetFlag" : false }, "infra_electric_wires" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_electric_wiresResourceAttribute", "exampleSetFlag" : false }, "equip_construction" : { "$ref" : "#/components/schemas/TkpAttachmentTagsEquip_constructionResourceAttribute", "exampleSetFlag" : false }, "ground_grass" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_grassResourceAttribute", "exampleSetFlag" : false }, "flags_gas" : { "$ref" : "#/components/schemas/TkpAttachmentTagsFlags_gasResourceAttribute", "exampleSetFlag" : false }, "utility_water" : { "$ref" : "#/components/schemas/TkpAttachmentTagsUtility_waterResourceAttribute", "exampleSetFlag" : false }, "infra_utility_hookup" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_utility_hookupResourceAttribute", "exampleSetFlag" : false }, "infra_meter_gas" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_meter_gasResourceAttribute", "exampleSetFlag" : false }, "extra_whitelining" : { "$ref" : "#/components/schemas/TkpAttachmentTagsExtra_whiteliningResourceAttribute", "exampleSetFlag" : false }, "equip_locator" : { "$ref" : "#/components/schemas/TkpAttachmentTagsEquip_locatorResourceAttribute", "exampleSetFlag" : false }, "ground_snow" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_snowResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/TkpAttachmentTagsTicket_idResourceAttribute", "exampleSetFlag" : false }, "nearby_gas" : { "$ref" : "#/components/schemas/TkpAttachmentTagsNearby_gasResourceAttribute", "exampleSetFlag" : false }, "nearby_water" : { "$ref" : "#/components/schemas/TkpAttachmentTagsNearby_waterResourceAttribute", "exampleSetFlag" : false }, "nearby_electric" : { "$ref" : "#/components/schemas/TkpAttachmentTagsNearby_electricResourceAttribute", "exampleSetFlag" : false }, "road_curb_white" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRoad_curb_whiteResourceAttribute", "exampleSetFlag" : false }, "weather_dry" : { "$ref" : "#/components/schemas/TkpAttachmentTagsWeather_dryResourceAttribute", "exampleSetFlag" : false }, "type_roadway" : { "$ref" : "#/components/schemas/TkpAttachmentTagsType_roadwayResourceAttribute", "exampleSetFlag" : false }, "ground_dirt" : { "$ref" : "#/components/schemas/TkpAttachmentTagsGround_dirtResourceAttribute", "exampleSetFlag" : false }, "equip_usic_truck" : { "$ref" : "#/components/schemas/TkpAttachmentTagsEquip_usic_truckResourceAttribute", "exampleSetFlag" : false }, "utility_electric" : { "$ref" : "#/components/schemas/TkpAttachmentTagsUtility_electricResourceAttribute", "exampleSetFlag" : false }, "extra_survey_pink" : { "$ref" : "#/components/schemas/TkpAttachmentTagsExtra_survey_pinkResourceAttribute", "exampleSetFlag" : false }, "created_date" : { "$ref" : "#/components/schemas/TkpAttachmentTagsCreated_dateResourceAttribute", "exampleSetFlag" : false }, "respond" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRespondResourceAttribute", "exampleSetFlag" : false }, "road_curb_blue" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRoad_curb_blueResourceAttribute", "exampleSetFlag" : false }, "scene_human" : { "$ref" : "#/components/schemas/TkpAttachmentTagsScene_humanResourceAttribute", "exampleSetFlag" : false }, "infra_erosion_wattle" : { "$ref" : "#/components/schemas/TkpAttachmentTagsInfra_erosion_wattleResourceAttribute", "exampleSetFlag" : false }, "road_line_red" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRoad_line_redResourceAttribute", "exampleSetFlag" : false }, "road_crosswalk" : { "$ref" : "#/components/schemas/TkpAttachmentTagsRoad_crosswalkResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentTagsEquip_locatorResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsUtility_gasResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsGround_snowResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsRoad_curb_blueResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsFlags_telecomResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentTagsInfra_garden_hoseResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/attachmentTags/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentTagsProcessed_atResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpAttachmentTagsClear_gasResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceLinks", "exampleSetFlag" : false } ] }, "TkpAttachmentTagsFlags_sewerResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsNearby_waterResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsClear_electricResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpAttachmentTagsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpAttachmentTagsInfra_erosion_wattleResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsType_new_homesResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpAttachmentTagsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpAttachmentTags)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpAttachmentTags" ] }, "id" : { "$ref" : "#/components/schemas/TkpAttachmentTagsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpCustomersPostResourceReference", "exampleSetFlag" : false } ] }, "TkpCustomersUtilitiesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TkpCustomersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/TkpCustomersAccount_numberResourceAttribute", "exampleSetFlag" : false }, "account_name" : { "$ref" : "#/components/schemas/TkpCustomersAccount_nameResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/TkpCustomersNameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "utilities" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/customers/{id}/relationships/utilities" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/customers/{id}/utilities" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersAccount_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpCustomersAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpCustomersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/customers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpCustomersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpCustomersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpCustomersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpCustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpCustomersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpCustomersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpCustomersResourceLinks", "exampleSetFlag" : false } ] }, "TkpCustomersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpCustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TkpCustomersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TkpCustomersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpCustomers" ] }, "id" : { "$ref" : "#/components/schemas/TkpCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpCustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpCustomers" ] }, "id" : { "$ref" : "#/components/schemas/TkpCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpCustomersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TkpCustomersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpCustomersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpCustomersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpDistrictsWork_hours_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpDistrictsLunch_lower_limitResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpDistrictsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpDistricts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpDistricts" ] }, "id" : { "$ref" : "#/components/schemas/TkpDistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsVisitsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TkpDistrictsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "productivity_goal" : { "$ref" : "#/components/schemas/TkpDistrictsProductivity_goalResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/TkpDistrictsZipResourceAttribute", "exampleSetFlag" : false }, "work_code" : { "$ref" : "#/components/schemas/TkpDistrictsWork_codeResourceAttribute", "exampleSetFlag" : false }, "company_id" : { "$ref" : "#/components/schemas/TkpDistrictsCompany_idResourceAttribute", "exampleSetFlag" : false }, "address2" : { "$ref" : "#/components/schemas/TkpDistrictsAddress2ResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/TkpDistrictsCityResourceAttribute", "exampleSetFlag" : false }, "address1" : { "$ref" : "#/components/schemas/TkpDistrictsAddress1ResourceAttribute", "exampleSetFlag" : false }, "time_zone" : { "$ref" : "#/components/schemas/TkpDistrictsTime_zoneResourceAttribute", "exampleSetFlag" : false }, "lunch_lower_limit" : { "$ref" : "#/components/schemas/TkpDistrictsLunch_lower_limitResourceAttribute", "exampleSetFlag" : false }, "client_pref_version" : { "$ref" : "#/components/schemas/TkpDistrictsClient_pref_versionResourceAttribute", "exampleSetFlag" : false }, "district_name" : { "$ref" : "#/components/schemas/TkpDistrictsDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "inactive" : { "$ref" : "#/components/schemas/TkpDistrictsInactiveResourceAttribute", "exampleSetFlag" : false }, "client_min_verison" : { "$ref" : "#/components/schemas/TkpDistrictsClient_min_verisonResourceAttribute", "exampleSetFlag" : false }, "district_abbrev" : { "$ref" : "#/components/schemas/TkpDistrictsDistrict_abbrevResourceAttribute", "exampleSetFlag" : false }, "lunch_upper_limit" : { "$ref" : "#/components/schemas/TkpDistrictsLunch_upper_limitResourceAttribute", "exampleSetFlag" : false }, "org_region_id" : { "$ref" : "#/components/schemas/TkpDistrictsOrg_region_idResourceAttribute", "exampleSetFlag" : false }, "district_code" : { "$ref" : "#/components/schemas/TkpDistrictsDistrict_codeResourceAttribute", "exampleSetFlag" : false }, "work_hours_id" : { "$ref" : "#/components/schemas/TkpDistrictsWork_hours_idResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/TkpDistrictsStateResourceAttribute", "exampleSetFlag" : false }, "clock_start" : { "$ref" : "#/components/schemas/TkpDistrictsClock_startResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsUsrsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TkpDistrictsAddress1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsZipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsClock_startResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsTime_zoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpDistricts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpDistricts" ] }, "id" : { "$ref" : "#/components/schemas/TkpDistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsCompany_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpDistrictsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/districts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsLunch_upper_limitResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpDistrictsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpDistrictsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsDistrict_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpDistrictsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpDistrictsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpDistrictsResourceLinks", "exampleSetFlag" : false } ] }, "TkpDistrictsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpDistrictsPostResourceReference", "exampleSetFlag" : false } ] }, "TkpDistrictsClient_min_verisonResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpDistrictsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpDistrictsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TkpDistrictsOrg_region_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpDistrictsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "visits" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/districts/{id}/relationships/visits" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/districts/{id}/visits" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "tickets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/districts/{id}/relationships/tickets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/districts/{id}/tickets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "usrs" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/districts/{id}/relationships/usrs" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/districts/{id}/usrs" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsTicketsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TkpDistrictsDistrict_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpDistrictsWork_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsAddress2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpDistrictsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TkpDistrictsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TkpDistrictsInactiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TkpDistrictsProductivity_goalResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TkpDistrictsDistrict_abbrevResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpDistrictsClient_pref_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpTicketsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpTickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpTickets" ] }, "id" : { "$ref" : "#/components/schemas/TkpTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpTicketsBilled_manuallyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TkpTicketsOur_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpTicketsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpTicketsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpTicketsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpTicketsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpTicketsTicket_contact_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpTicketsTicket_invoice_signature_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpTicketsExcavator_contact_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpTicketsOpenResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TkpTicketsBill_to_contact_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpTicketsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpTickets)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpTickets" ] }, "id" : { "$ref" : "#/components/schemas/TkpTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpTicketsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpTicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpTicketsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpTicketsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpTicketsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpTicketsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpTicketsResourceLinks", "exampleSetFlag" : false } ] }, "TkpTicketsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpTicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpTicketsTicket_sup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpTicketsClosed_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpTicketsTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpTicketsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "serviceAccountLocateMatches" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/tickets/{id}/relationships/serviceAccountLocateMatches" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/tickets/{id}/serviceAccountLocateMatches" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpTicketsTicket_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpTicketsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpTicketsPostResourceReference", "exampleSetFlag" : false } ] }, "TkpTicketsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpTicketsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "bill_to_contact_id" : { "$ref" : "#/components/schemas/TkpTicketsBill_to_contact_idResourceAttribute", "exampleSetFlag" : false }, "closed_date" : { "$ref" : "#/components/schemas/TkpTicketsClosed_dateResourceAttribute", "exampleSetFlag" : false }, "billed_manually" : { "$ref" : "#/components/schemas/TkpTicketsBilled_manuallyResourceAttribute", "exampleSetFlag" : false }, "latest_transmission_id" : { "$ref" : "#/components/schemas/TkpTicketsLatest_transmission_idResourceAttribute", "exampleSetFlag" : false }, "excavator_contact_id" : { "$ref" : "#/components/schemas/TkpTicketsExcavator_contact_idResourceAttribute", "exampleSetFlag" : false }, "risk_score" : { "$ref" : "#/components/schemas/TkpTicketsRisk_scoreResourceAttribute", "exampleSetFlag" : false }, "locate_list_cache" : { "$ref" : "#/components/schemas/TkpTicketsLocate_list_cacheResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/TkpTicketsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "open_emergency" : { "$ref" : "#/components/schemas/TkpTicketsOpen_emergencyResourceAttribute", "exampleSetFlag" : false }, "ticket_district_id" : { "$ref" : "#/components/schemas/TkpTicketsTicket_district_idResourceAttribute", "exampleSetFlag" : false }, "ticket_contact_id" : { "$ref" : "#/components/schemas/TkpTicketsTicket_contact_idResourceAttribute", "exampleSetFlag" : false }, "ticket_sup_group_id" : { "$ref" : "#/components/schemas/TkpTicketsTicket_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "ordered_by_contact_id" : { "$ref" : "#/components/schemas/TkpTicketsOrdered_by_contact_idResourceAttribute", "exampleSetFlag" : false }, "our_due_date" : { "$ref" : "#/components/schemas/TkpTicketsOur_due_dateResourceAttribute", "exampleSetFlag" : false }, "ticket_invoice_signature_id" : { "$ref" : "#/components/schemas/TkpTicketsTicket_invoice_signature_idResourceAttribute", "exampleSetFlag" : false }, "open" : { "$ref" : "#/components/schemas/TkpTicketsOpenResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpTicketsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpTicketsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TkpTicketsRisk_scoreResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TkpTicketsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/tickets/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpTicketsOrdered_by_contact_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpTicketsLatest_transmission_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpTicketsLocate_list_cacheResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpTicketsOpen_emergencyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TkpTicketsServiceAccountLocateMatchesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TkpTicketsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TkpTicketsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TkpTicketsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpTicketsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersServiceAccountLocateMatchesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TkpcustomersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpcustomersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpcustomersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "account_number" : { "$ref" : "#/components/schemas/TkpcustomersAccount_numberResourceAttribute", "exampleSetFlag" : false }, "account_name" : { "$ref" : "#/components/schemas/TkpcustomersAccount_nameResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/TkpcustomersNameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpcustomersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TkpcustomersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpcustomersPostResourceReference", "exampleSetFlag" : false } ] }, "TkpcustomersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/customers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersServiceAccountsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TkpcustomersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpcustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpcustomers" ] }, "id" : { "$ref" : "#/components/schemas/TkpcustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TkpcustomersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TkpcustomersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpcustomersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpcustomersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TkpcustomersResourceLinks", "exampleSetFlag" : false } ] }, "TkpcustomersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpcustomersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TkpcustomersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpcustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "serviceAccounts" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/customers/{id}/relationships/serviceAccounts" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/customers/{id}/serviceAccounts" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "serviceAccountLocateMatches" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/customers/{id}/relationships/serviceAccountLocateMatches" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketproServices/1.0/customers/{id}/serviceAccountLocateMatches" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TkpcustomersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tkpcustomers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tkpcustomers" ] }, "id" : { "$ref" : "#/components/schemas/TkpcustomersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TkpcustomersAccount_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TokensPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TokensPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensUserResourceAttribute" : { "$ref" : "#/components/schemas/WsUsersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TokensResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TokensResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TokensResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TokensResourceLinks", "exampleSetFlag" : false } ] }, "TokensEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "TokensPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tokens)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tokens" ] }, "id" : { "$ref" : "#/components/schemas/TokensIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "userAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/tokens/{id}/relationships/userAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/tokens/{id}/userAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "user" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/tokens/{id}/relationships/user" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/tokens/{id}/user" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TokensPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TokensResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TokensResourcePostRelationships", "exampleSetFlag" : false } ] }, "TokensPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TokensPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TokensResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensUser_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TokensResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TokensResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TokensResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/tokens/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TokensResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TokensResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensTokenResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TokensResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/TokensEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/TokensLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/TokensUser_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/TokensLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/TokensCreated_byResourceAttribute", "exampleSetFlag" : false }, "token" : { "$ref" : "#/components/schemas/TokensTokenResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/TokensStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TokensResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (tokens)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "tokens" ] }, "id" : { "$ref" : "#/components/schemas/TokensIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TokensResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TokensResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TokensCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "TokensResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/TokensEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/TokensLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/TokensUser_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/TokensCreated_byResourceAttribute", "exampleSetFlag" : false }, "token" : { "$ref" : "#/components/schemas/TokensTokenResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/TokensStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "TokensResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "userAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "user" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "userAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "user" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TokensUserAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TokensLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "TokensResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/TokensEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/TokensLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/TokensUser_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/TokensCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/TokensLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/TokensCreated_byResourceAttribute", "exampleSetFlag" : false }, "token" : { "$ref" : "#/components/schemas/TokensTokenResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/TokensStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissionExtras)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissionExtras" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionExtrasIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasSingle_addressResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasOriginal_ticket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionExtrasResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "original_ticket_number" : { "$ref" : "#/components/schemas/TransmissionExtrasOriginal_ticket_numberResourceAttribute", "exampleSetFlag" : false }, "zip" : { "$ref" : "#/components/schemas/TransmissionExtrasZipResourceAttribute", "exampleSetFlag" : false }, "sidewalk" : { "$ref" : "#/components/schemas/TransmissionExtrasSidewalkResourceAttribute", "exampleSetFlag" : false }, "identifier" : { "$ref" : "#/components/schemas/TransmissionExtrasIdentifierResourceAttribute", "exampleSetFlag" : false }, "in_street" : { "$ref" : "#/components/schemas/TransmissionExtrasIn_streetResourceAttribute", "exampleSetFlag" : false }, "marking_instructions" : { "$ref" : "#/components/schemas/TransmissionExtrasMarking_instructionsResourceAttribute", "exampleSetFlag" : false }, "single_address" : { "$ref" : "#/components/schemas/TransmissionExtrasSingle_addressResourceAttribute", "exampleSetFlag" : false }, "driving_instructions" : { "$ref" : "#/components/schemas/TransmissionExtrasDriving_instructionsResourceAttribute", "exampleSetFlag" : false }, "remark" : { "$ref" : "#/components/schemas/TransmissionExtrasRemarkResourceAttribute", "exampleSetFlag" : false }, "excavation_means" : { "$ref" : "#/components/schemas/TransmissionExtrasExcavation_meansResourceAttribute", "exampleSetFlag" : false }, "duration" : { "$ref" : "#/components/schemas/TransmissionExtrasDurationResourceAttribute", "exampleSetFlag" : false }, "depth" : { "$ref" : "#/components/schemas/TransmissionExtrasDepthResourceAttribute", "exampleSetFlag" : false }, "original_ticket_id" : { "$ref" : "#/components/schemas/TransmissionExtrasOriginal_ticket_idResourceAttribute", "exampleSetFlag" : false }, "excavator_zip" : { "$ref" : "#/components/schemas/TransmissionExtrasExcavator_zipResourceAttribute", "exampleSetFlag" : false }, "contact" : { "$ref" : "#/components/schemas/TransmissionExtrasContactResourceAttribute", "exampleSetFlag" : false }, "contact_mobile" : { "$ref" : "#/components/schemas/TransmissionExtrasContact_mobileResourceAttribute", "exampleSetFlag" : false }, "cross_ref" : { "$ref" : "#/components/schemas/TransmissionExtrasCross_refResourceAttribute", "exampleSetFlag" : false }, "whitelined" : { "$ref" : "#/components/schemas/TransmissionExtrasWhitelinedResourceAttribute", "exampleSetFlag" : false }, "contract_seq" : { "$ref" : "#/components/schemas/TransmissionExtrasContract_seqResourceAttribute", "exampleSetFlag" : false }, "township" : { "$ref" : "#/components/schemas/TransmissionExtrasTownshipResourceAttribute", "exampleSetFlag" : false }, "excavator_state" : { "$ref" : "#/components/schemas/TransmissionExtrasExcavator_stateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionExtras/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionExtrasResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionExtrasResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionExtrasResourceLinks", "exampleSetFlag" : false } ] }, "TransmissionExtrasResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "locates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionExtras/{id}/relationships/locates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionExtras/{id}/locates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasTownshipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasDriving_instructionsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasMarking_instructionsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasContactResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionExtrasPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasSidewalkResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionExtrasIdentifierResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasContact_mobileResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TransmissionExtrasDepthResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasIn_streetResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionExtrasResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasRemarkResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionExtrasPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionExtrasPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasCross_refResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasExcavation_meansResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasOriginal_ticket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissionExtras)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissionExtras" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionExtrasIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionExtrasResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TransmissionExtrasWhitelinedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionExtrasExcavator_zipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionExtrasPostResourceReference", "exampleSetFlag" : false } ] }, "TransmissionExtrasContract_seqResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasExcavator_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionExtrasLocatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionExtrasDurationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasZipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionExtrasResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsWork_done_forResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsTrans_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsService_area_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsCaller_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBlastingResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsMeet_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsEmergencyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsMeet_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsMaster_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsPostResourceReference", "exampleSetFlag" : false } ] }, "TransmissionsCaller_faxResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsTransmission_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBoringResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsVersion_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTickettypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsCaller_phoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsExcavator_address_1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TransmissionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TransmissionsShort_noticeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsTransmit_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsRaw_imageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissions" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsResourceLinks", "exampleSetFlag" : false } ] }, "TransmissionsCross_street2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cross_street2" : { "$ref" : "#/components/schemas/TransmissionsCross_street2ResourceAttribute", "exampleSetFlag" : false }, "streetname" : { "$ref" : "#/components/schemas/TransmissionsStreetnameResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/TransmissionsCountyResourceAttribute", "exampleSetFlag" : false }, "emergency" : { "$ref" : "#/components/schemas/TransmissionsEmergencyResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/TransmissionsVersion_numberResourceAttribute", "exampleSetFlag" : false }, "meet_date" : { "$ref" : "#/components/schemas/TransmissionsMeet_dateResourceAttribute", "exampleSetFlag" : false }, "transmission_type" : { "$ref" : "#/components/schemas/TransmissionsTransmission_typeResourceAttribute", "exampleSetFlag" : false }, "feed_id" : { "$ref" : "#/components/schemas/TransmissionsFeed_idResourceAttribute", "exampleSetFlag" : false }, "blasting" : { "$ref" : "#/components/schemas/TransmissionsBlastingResourceAttribute", "exampleSetFlag" : false }, "typeofwork" : { "$ref" : "#/components/schemas/TransmissionsTypeofworkResourceAttribute", "exampleSetFlag" : false }, "added_by_id" : { "$ref" : "#/components/schemas/TransmissionsAdded_by_idResourceAttribute", "exampleSetFlag" : false }, "caller_email" : { "$ref" : "#/components/schemas/TransmissionsCaller_emailResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/TransmissionsStateResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/TransmissionsLatResourceAttribute", "exampleSetFlag" : false }, "cross_street1" : { "$ref" : "#/components/schemas/TransmissionsCross_street1ResourceAttribute", "exampleSetFlag" : false }, "mapbook" : { "$ref" : "#/components/schemas/TransmissionsMapbookResourceAttribute", "exampleSetFlag" : false }, "caller_fax" : { "$ref" : "#/components/schemas/TransmissionsCaller_faxResourceAttribute", "exampleSetFlag" : false }, "message_type" : { "$ref" : "#/components/schemas/TransmissionsMessage_typeResourceAttribute", "exampleSetFlag" : false }, "billing_code" : { "$ref" : "#/components/schemas/TransmissionsBilling_codeResourceAttribute", "exampleSetFlag" : false }, "caller_phone" : { "$ref" : "#/components/schemas/TransmissionsCaller_phoneResourceAttribute", "exampleSetFlag" : false }, "sourcefilename" : { "$ref" : "#/components/schemas/TransmissionsSourcefilenameResourceAttribute", "exampleSetFlag" : false }, "after_hours" : { "$ref" : "#/components/schemas/TransmissionsAfter_hoursResourceAttribute", "exampleSetFlag" : false }, "parse_date" : { "$ref" : "#/components/schemas/TransmissionsParse_dateResourceAttribute", "exampleSetFlag" : false }, "trans_number" : { "$ref" : "#/components/schemas/TransmissionsTrans_numberResourceAttribute", "exampleSetFlag" : false }, "download_time" : { "$ref" : "#/components/schemas/TransmissionsDownload_timeResourceAttribute", "exampleSetFlag" : false }, "transmit_date" : { "$ref" : "#/components/schemas/TransmissionsTransmit_dateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/TransmissionsCityResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/TransmissionsDescriptionResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/TransmissionsLonResourceAttribute", "exampleSetFlag" : false }, "meet_code" : { "$ref" : "#/components/schemas/TransmissionsMeet_codeResourceAttribute", "exampleSetFlag" : false }, "subdivision" : { "$ref" : "#/components/schemas/TransmissionsSubdivisionResourceAttribute", "exampleSetFlag" : false }, "caller_name" : { "$ref" : "#/components/schemas/TransmissionsCaller_nameResourceAttribute", "exampleSetFlag" : false }, "transmitted_legal_due_date" : { "$ref" : "#/components/schemas/TransmissionsTransmitted_legal_due_dateResourceAttribute", "exampleSetFlag" : false }, "excavator_city" : { "$ref" : "#/components/schemas/TransmissionsExcavator_cityResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/TransmissionsExcavatorResourceAttribute", "exampleSetFlag" : false }, "street_dir" : { "$ref" : "#/components/schemas/TransmissionsStreet_dirResourceAttribute", "exampleSetFlag" : false }, "lead_time" : { "$ref" : "#/components/schemas/TransmissionsLead_timeResourceAttribute", "exampleSetFlag" : false }, "excavator_address_1" : { "$ref" : "#/components/schemas/TransmissionsExcavator_address_1ResourceAttribute", "exampleSetFlag" : false }, "tickettype" : { "$ref" : "#/components/schemas/TransmissionsTickettypeResourceAttribute", "exampleSetFlag" : false }, "usic_ticket_type" : { "$ref" : "#/components/schemas/TransmissionsUsic_ticket_typeResourceAttribute", "exampleSetFlag" : false }, "work_done_for" : { "$ref" : "#/components/schemas/TransmissionsWork_done_forResourceAttribute", "exampleSetFlag" : false }, "work_date" : { "$ref" : "#/components/schemas/TransmissionsWork_dateResourceAttribute", "exampleSetFlag" : false }, "service_area_code" : { "$ref" : "#/components/schemas/TransmissionsService_area_codeResourceAttribute", "exampleSetFlag" : false }, "maplocation" : { "$ref" : "#/components/schemas/TransmissionsMaplocationResourceAttribute", "exampleSetFlag" : false }, "master_code" : { "$ref" : "#/components/schemas/TransmissionsMaster_codeResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/TransmissionsTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/TransmissionsTicket_numberResourceAttribute", "exampleSetFlag" : false }, "raw_image" : { "$ref" : "#/components/schemas/TransmissionsRaw_imageResourceAttribute", "exampleSetFlag" : false }, "call_date" : { "$ref" : "#/components/schemas/TransmissionsCall_dateResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/TransmissionsBoringResourceAttribute", "exampleSetFlag" : false }, "meet" : { "$ref" : "#/components/schemas/TransmissionsMeetResourceAttribute", "exampleSetFlag" : false }, "street_number" : { "$ref" : "#/components/schemas/TransmissionsStreet_numberResourceAttribute", "exampleSetFlag" : false }, "short_notice" : { "$ref" : "#/components/schemas/TransmissionsShort_noticeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsMaplocationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsSourcefilenameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBilling_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDownload_timeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsLocatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsFeedResourceAttribute" : { "$ref" : "#/components/schemas/FeedsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TransmissionsCpClosedTicketsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsExcavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsStreetnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TransmissionsCross_street1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsExcavator_cityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsStreet_dirResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TransmissionsTicketsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsFeed_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsStreet_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsUsic_ticket_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsTypeofworkResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissions" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsParse_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsWork_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsMeetResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsCall_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsSubdivisionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsLead_timeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "feed" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissions/{id}/relationships/feed" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissions/{id}/feed" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "tickets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissions/{id}/relationships/tickets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissions/{id}/tickets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cpClosedTickets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissions/{id}/relationships/cpClosedTickets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissions/{id}/cpClosedTickets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissions/{id}/relationships/locates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissions/{id}/locates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTransmitted_legal_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsMessage_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsAfter_hoursResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsAdded_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsMapbookResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsCaller_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "feed" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/relationships/feed" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/feed" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/FeedsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionText" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/relationships/transmissionText" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/transmissionText" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionExtra" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/relationships/transmissionExtra" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/transmissionExtra" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "tickets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/relationships/tickets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/tickets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "responseLogs" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/relationships/responseLogs" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/responseLogs" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "cpClosedTickets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/relationships/cpClosedTickets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/cpClosedTickets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/relationships/locates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/locates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/relationships/transmissionDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}/transmissionDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBaseAdded_by_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsBaseStreetnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseLocatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsBaseMeet_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseTransmit_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseResponseLogsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ResponseLogsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsBaseEmergencyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsBaseSubdivisionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseUsic_ticket_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseFeedResourceAttribute" : { "$ref" : "#/components/schemas/FeedsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TransmissionsBaseResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissionsBase)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissionsBase" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionsBaseIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBaseResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceLinks", "exampleSetFlag" : false } ] }, "TransmissionsBaseCall_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBasePostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBasePostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBaseLead_timeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsBaseResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TransmissionsBaseTransmissionDetailResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TransmissionsBaseTrans_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseTicketsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsBaseBlastingResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsBaseTypeofworkResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TransmissionsBaseWork_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseStreet_dirResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBasePostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsBasePostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBasePatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBaseTransmitted_legal_due_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseDownload_timeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseService_area_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseBilling_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsBaseTickettypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseTransmissionExtraResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TransmissionsBasePostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsBasePostResourceReference", "exampleSetFlag" : false } ] }, "TransmissionsBaseShort_noticeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsBaseMeetResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsBaseFeed_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsBaseCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseTicket_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseStreet_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseAfter_hoursResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsBaseResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "trans_number" : { "$ref" : "#/components/schemas/TransmissionsBaseTrans_numberResourceAttribute", "exampleSetFlag" : false }, "download_time" : { "$ref" : "#/components/schemas/TransmissionsBaseDownload_timeResourceAttribute", "exampleSetFlag" : false }, "transmit_date" : { "$ref" : "#/components/schemas/TransmissionsBaseTransmit_dateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/TransmissionsBaseCityResourceAttribute", "exampleSetFlag" : false }, "streetname" : { "$ref" : "#/components/schemas/TransmissionsBaseStreetnameResourceAttribute", "exampleSetFlag" : false }, "county" : { "$ref" : "#/components/schemas/TransmissionsBaseCountyResourceAttribute", "exampleSetFlag" : false }, "emergency" : { "$ref" : "#/components/schemas/TransmissionsBaseEmergencyResourceAttribute", "exampleSetFlag" : false }, "meet_date" : { "$ref" : "#/components/schemas/TransmissionsBaseMeet_dateResourceAttribute", "exampleSetFlag" : false }, "transmission_type" : { "$ref" : "#/components/schemas/TransmissionsBaseTransmission_typeResourceAttribute", "exampleSetFlag" : false }, "feed_id" : { "$ref" : "#/components/schemas/TransmissionsBaseFeed_idResourceAttribute", "exampleSetFlag" : false }, "meet_code" : { "$ref" : "#/components/schemas/TransmissionsBaseMeet_codeResourceAttribute", "exampleSetFlag" : false }, "blasting" : { "$ref" : "#/components/schemas/TransmissionsBaseBlastingResourceAttribute", "exampleSetFlag" : false }, "subdivision" : { "$ref" : "#/components/schemas/TransmissionsBaseSubdivisionResourceAttribute", "exampleSetFlag" : false }, "transmitted_legal_due_date" : { "$ref" : "#/components/schemas/TransmissionsBaseTransmitted_legal_due_dateResourceAttribute", "exampleSetFlag" : false }, "street_dir" : { "$ref" : "#/components/schemas/TransmissionsBaseStreet_dirResourceAttribute", "exampleSetFlag" : false }, "typeofwork" : { "$ref" : "#/components/schemas/TransmissionsBaseTypeofworkResourceAttribute", "exampleSetFlag" : false }, "added_by_id" : { "$ref" : "#/components/schemas/TransmissionsBaseAdded_by_idResourceAttribute", "exampleSetFlag" : false }, "lead_time" : { "$ref" : "#/components/schemas/TransmissionsBaseLead_timeResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/TransmissionsBaseStateResourceAttribute", "exampleSetFlag" : false }, "tickettype" : { "$ref" : "#/components/schemas/TransmissionsBaseTickettypeResourceAttribute", "exampleSetFlag" : false }, "usic_ticket_type" : { "$ref" : "#/components/schemas/TransmissionsBaseUsic_ticket_typeResourceAttribute", "exampleSetFlag" : false }, "work_date" : { "$ref" : "#/components/schemas/TransmissionsBaseWork_dateResourceAttribute", "exampleSetFlag" : false }, "service_area_code" : { "$ref" : "#/components/schemas/TransmissionsBaseService_area_codeResourceAttribute", "exampleSetFlag" : false }, "message_type" : { "$ref" : "#/components/schemas/TransmissionsBaseMessage_typeResourceAttribute", "exampleSetFlag" : false }, "master_code" : { "$ref" : "#/components/schemas/TransmissionsBaseMaster_codeResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/TransmissionsBaseTicket_idResourceAttribute", "exampleSetFlag" : false }, "ticket_number" : { "$ref" : "#/components/schemas/TransmissionsBaseTicket_numberResourceAttribute", "exampleSetFlag" : false }, "billing_code" : { "$ref" : "#/components/schemas/TransmissionsBaseBilling_codeResourceAttribute", "exampleSetFlag" : false }, "call_date" : { "$ref" : "#/components/schemas/TransmissionsBaseCall_dateResourceAttribute", "exampleSetFlag" : false }, "meet" : { "$ref" : "#/components/schemas/TransmissionsBaseMeetResourceAttribute", "exampleSetFlag" : false }, "street_number" : { "$ref" : "#/components/schemas/TransmissionsBaseStreet_numberResourceAttribute", "exampleSetFlag" : false }, "after_hours" : { "$ref" : "#/components/schemas/TransmissionsBaseAfter_hoursResourceAttribute", "exampleSetFlag" : false }, "short_notice" : { "$ref" : "#/components/schemas/TransmissionsBaseShort_noticeResourceAttribute", "exampleSetFlag" : false }, "parse_date" : { "$ref" : "#/components/schemas/TransmissionsBaseParse_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBaseCpClosedTicketsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketClosedsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsBaseResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsBase/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBaseTransmissionTextResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TransmissionsBaseResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBaseTransmission_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseParse_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsBasePostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissionsBase)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissionsBase" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionsBaseIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBaseMaster_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseMeet_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsBaseCountyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsBaseMessage_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailLocatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsDetailPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsDetailPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TransmissionsDetailIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsDetailMapbookResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailMaplocationResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissionsDetail)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissionsDetail" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionsDetailIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailLatResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TransmissionsDetailCaller_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailBoringResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "TransmissionsDetailCaller_faxResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailExcavator_cityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailVersion_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailTransmissionTextResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TransmissionsDetailPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsDetailPostResourceReference", "exampleSetFlag" : false } ] }, "TransmissionsDetailResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "transmissionText" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/relationships/transmissionText" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/transmissionText" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "tickets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/relationships/tickets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/tickets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "digAreas" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/relationships/digAreas" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/digAreas" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DigAreasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DigAreasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "locates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/relationships/locates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/locates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionBase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/relationships/transmissionBase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsDetail/{id}/transmissionBase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailTransmissionBaseResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TransmissionsDetailExcavator_address_1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailLonResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "TransmissionsDetailResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissionsDetail)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissionsDetail" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionsDetailIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailCaller_phoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TransmissionsDetailTicketsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsDetailDigAreasResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DigAreasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsDetailPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailCaller_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailDescriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailCross_street1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailWork_done_forResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "mapbook" : { "$ref" : "#/components/schemas/TransmissionsDetailMapbookResourceAttribute", "exampleSetFlag" : false }, "cross_street2" : { "$ref" : "#/components/schemas/TransmissionsDetailCross_street2ResourceAttribute", "exampleSetFlag" : false }, "work_done_for" : { "$ref" : "#/components/schemas/TransmissionsDetailWork_done_forResourceAttribute", "exampleSetFlag" : false }, "maplocation" : { "$ref" : "#/components/schemas/TransmissionsDetailMaplocationResourceAttribute", "exampleSetFlag" : false }, "caller_fax" : { "$ref" : "#/components/schemas/TransmissionsDetailCaller_faxResourceAttribute", "exampleSetFlag" : false }, "description" : { "$ref" : "#/components/schemas/TransmissionsDetailDescriptionResourceAttribute", "exampleSetFlag" : false }, "lon" : { "$ref" : "#/components/schemas/TransmissionsDetailLonResourceAttribute", "exampleSetFlag" : false }, "version_number" : { "$ref" : "#/components/schemas/TransmissionsDetailVersion_numberResourceAttribute", "exampleSetFlag" : false }, "caller_name" : { "$ref" : "#/components/schemas/TransmissionsDetailCaller_nameResourceAttribute", "exampleSetFlag" : false }, "boring" : { "$ref" : "#/components/schemas/TransmissionsDetailBoringResourceAttribute", "exampleSetFlag" : false }, "caller_phone" : { "$ref" : "#/components/schemas/TransmissionsDetailCaller_phoneResourceAttribute", "exampleSetFlag" : false }, "excavator_city" : { "$ref" : "#/components/schemas/TransmissionsDetailExcavator_cityResourceAttribute", "exampleSetFlag" : false }, "excavator" : { "$ref" : "#/components/schemas/TransmissionsDetailExcavatorResourceAttribute", "exampleSetFlag" : false }, "sourcefilename" : { "$ref" : "#/components/schemas/TransmissionsDetailSourcefilenameResourceAttribute", "exampleSetFlag" : false }, "caller_email" : { "$ref" : "#/components/schemas/TransmissionsDetailCaller_emailResourceAttribute", "exampleSetFlag" : false }, "excavator_address_1" : { "$ref" : "#/components/schemas/TransmissionsDetailExcavator_address_1ResourceAttribute", "exampleSetFlag" : false }, "lat" : { "$ref" : "#/components/schemas/TransmissionsDetailLatResourceAttribute", "exampleSetFlag" : false }, "cross_street1" : { "$ref" : "#/components/schemas/TransmissionsDetailCross_street1ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsDetailSourcefilenameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailExcavatorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsDetailResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceLinks", "exampleSetFlag" : false } ] }, "TransmissionsDetailCross_street2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsTextPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTextPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsTextPostResourceReference", "exampleSetFlag" : false } ] }, "TransmissionsTextTransmissionDetailResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TransmissionsTextResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "raw_image" : { "$ref" : "#/components/schemas/TransmissionsTextRaw_imageResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTextResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsTextResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "TransmissionsTextPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissionsText)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissionsText" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionsTextIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTextResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsTextResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "TransmissionsTextResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTextPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsTextPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTextRaw_imageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "TransmissionsTextResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (transmissionsText)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "transmissionsText" ] }, "id" : { "$ref" : "#/components/schemas/TransmissionsTextIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTextPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsTextPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTextTransmissionBaseResourceAttribute" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "nullable" : true, "exampleSetFlag" : false }, "TransmissionsTextResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "locates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsText/{id}/relationships/locates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsText/{id}/locates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionDetail" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsText/{id}/relationships/transmissionDetail" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsText/{id}/transmissionDetail" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsDetailResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "transmissionBase" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsText/{id}/relationships/transmissionBase" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsText/{id}/transmissionBase" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TransmissionsBaseResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTextIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "TransmissionsTextLocatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/LocatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "TransmissionsTextResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsTextResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsTextResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/TransmissionsTextResourceLinks", "exampleSetFlag" : false } ] }, "TransmissionsTextResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "TransmissionsTextResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/transmissionsText/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserAccessesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerContract" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "user" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccessesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccessesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/UserAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "customer_contract_id" : { "$ref" : "#/components/schemas/UserAccessesCustomer_contract_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserAccessesCreated_onResourceAttribute", "exampleSetFlag" : false }, "customer_states" : { "$ref" : "#/components/schemas/UserAccessesCustomer_statesResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UserAccessesEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserAccessesCp_user_idResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UserAccessesEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/UserAccessesCustomer_account_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserAccessesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/UserAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "customer_contract_id" : { "$ref" : "#/components/schemas/UserAccessesCustomer_contract_idResourceAttribute", "exampleSetFlag" : false }, "customer_states" : { "$ref" : "#/components/schemas/UserAccessesCustomer_statesResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UserAccessesEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserAccessesCp_user_idResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UserAccessesEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/UserAccessesCustomer_account_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserAccessesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserAccessesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userAccesses" ] }, "id" : { "$ref" : "#/components/schemas/UserAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserAccessesUserResourceAttribute" : { "$ref" : "#/components/schemas/UsersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserAccessesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userAccesses" ] }, "id" : { "$ref" : "#/components/schemas/UserAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesCustomerContractResourceAttribute" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserAccessesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccessesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccessesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccessesResourceLinks", "exampleSetFlag" : false } ] }, "UserAccessesCustomer_statesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccessesCustomer_contract_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserAccessesCustomerAccountResourceAttribute" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserAccessesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerContract" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccesses/{id}/relationships/customerContract" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccesses/{id}/customerContract" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "user" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccesses/{id}/relationships/user" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccesses/{id}/user" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerAccount" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccesses/{id}/relationships/customerAccount" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccesses/{id}/customerAccount" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserAccessesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccessesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccesses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserAccessesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/UserAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "customer_contract_id" : { "$ref" : "#/components/schemas/UserAccessesCustomer_contract_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserAccessesCreated_onResourceAttribute", "exampleSetFlag" : false }, "customer_states" : { "$ref" : "#/components/schemas/UserAccessesCustomer_statesResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UserAccessesEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserAccessesCp_user_idResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UserAccessesEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/UserAccessesCustomer_account_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserAccessesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserAccessesCp_user_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserAccessesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerContract" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "user" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesCustomer_account_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserAccessesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccessesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserAccessesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccessesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccessesResourcePostRelationships", "exampleSetFlag" : false } ] }, "UserAccessesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserAccessesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccessesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserAccessesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserAccountAccessViewCp_user_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserAccountAccessViewPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userAccountAccessView)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userAccountAccessView" ] }, "id" : { "$ref" : "#/components/schemas/UserAccountAccessViewIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccountAccessViewPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserAccountAccessViewPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountAccessViewResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewCustomer_account_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserAccountAccessViewResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccountAccessView/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserAccountAccessViewResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountAccessViewResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountAccessViewResourceLinks", "exampleSetFlag" : false } ] }, "UserAccountAccessViewResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserAccountAccessViewResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserAccountAccessViewPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountAccessViewPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserAccountAccessViewCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/UserAccountAccessViewAccount_numberResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserAccountAccessViewCp_user_idResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/UserAccountAccessViewCustomer_account_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountAccessViewResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserAccountAccessViewResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserAccountAccessViewCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/UserAccountAccessViewAccount_numberResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserAccountAccessViewCp_user_idResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/UserAccountAccessViewCustomer_account_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccountAccessViewCp_user_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccountAccessViewPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserAccountAccessViewPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountAccessViewResourcePostAttributes", "exampleSetFlag" : false } ] }, "UserAccountAccessViewResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserAccountAccessViewCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/UserAccountAccessViewAccount_numberResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserAccountAccessViewCp_user_idResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/UserAccountAccessViewCustomer_account_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserAccountAccessViewResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserAccountAccessViewResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountAccessViewResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountAccessViewResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userAccountAccessView)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userAccountAccessView" ] }, "id" : { "$ref" : "#/components/schemas/UserAccountAccessViewIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/UserAccountContractAccessesAccount_numberResourceAttribute", "exampleSetFlag" : false }, "customer_contract_id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCustomer_contract_idResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/UserAccountContractAccessesContract_numberResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/UserAccountContractAccessesContract_nameResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCp_user_idResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCustomer_account_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountContractAccessesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountContractAccessesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesCp_user_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccountContractAccessesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/UserAccountContractAccessesAccount_numberResourceAttribute", "exampleSetFlag" : false }, "customer_contract_id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCustomer_contract_idResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/UserAccountContractAccessesContract_numberResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/UserAccountContractAccessesContract_nameResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCp_user_idResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCustomer_account_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountContractAccessesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceLinks", "exampleSetFlag" : false } ] }, "UserAccountContractAccessesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userAccountContractAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userAccountContractAccesses" ] }, "id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesCustomer_contract_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserAccountContractAccessesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccountContractAccesses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "account_number" : { "$ref" : "#/components/schemas/UserAccountContractAccessesAccount_numberResourceAttribute", "exampleSetFlag" : false }, "customer_contract_id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCustomer_contract_idResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/UserAccountContractAccessesContract_numberResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/UserAccountContractAccessesContract_nameResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCp_user_idResourceAttribute", "exampleSetFlag" : false }, "customer_account_id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesCustomer_account_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesContract_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccountContractAccessesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerContract" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerAccount" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerContract" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerAccount" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesCp_user_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserAccountContractAccessesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserAccountContractAccessesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesCustomer_account_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserAccountContractAccessesCustomerContractResourceAttribute" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserAccountContractAccessesContract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccountContractAccessesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserAccountContractAccessesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountContractAccessesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserAccountContractAccessesResourcePostRelationships", "exampleSetFlag" : false } ] }, "UserAccountContractAccessesAccount_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserAccountContractAccessesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserAccountContractAccessesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "customerContract" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccountContractAccesses/{id}/relationships/customerContract" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccountContractAccesses/{id}/customerContract" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerAccount" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccountContractAccesses/{id}/relationships/customerAccount" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userAccountContractAccesses/{id}/customerAccount" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userAccountContractAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userAccountContractAccesses" ] }, "id" : { "$ref" : "#/components/schemas/UserAccountContractAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserAccountContractAccessesCustomerAccountResourceAttribute" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserAccountContractAccessesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserAccountContractAccessesIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsGeneral_contactResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userContacts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userContacts" ] }, "id" : { "$ref" : "#/components/schemas/UserContactsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserContactsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserContactsRd_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userContacts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userContacts" ] }, "id" : { "$ref" : "#/components/schemas/UserContactsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserContactsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserContactsGeneral_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsCp_district_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsRd_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserContactsSales_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsCp_user_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsHrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsCp_district_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsHr_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userContacts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserContactsUsic_contact_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserContactsCp_district_codeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserContactsAddress_line2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsRd_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsIt_support_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserContactsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserContactsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserContactsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserContactsAddress_line3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsDistrict_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserContactsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserContactsDm_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsSales_contactResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsIt_supportResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsCountryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserContactsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserContactsSales_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserContactsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserContactsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserContactsResourceLinks", "exampleSetFlag" : false } ] }, "UserContactsGeneral_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsAddress_line1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserContactsPostResourceReference", "exampleSetFlag" : false } ] }, "UserContactsEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserContactsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserContactsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserContactsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserContactsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserContactsDm_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsDm_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserContactsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserContactsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserContactsCp_user_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserContactsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserContactsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "country" : { "$ref" : "#/components/schemas/UserContactsCountryResourceAttribute", "exampleSetFlag" : false }, "district_state" : { "$ref" : "#/components/schemas/UserContactsDistrict_stateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/UserContactsCityResourceAttribute", "exampleSetFlag" : false }, "cp_district_name" : { "$ref" : "#/components/schemas/UserContactsCp_district_nameResourceAttribute", "exampleSetFlag" : false }, "sales_contact" : { "$ref" : "#/components/schemas/UserContactsSales_contactResourceAttribute", "exampleSetFlag" : false }, "hr" : { "$ref" : "#/components/schemas/UserContactsHrResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UserContactsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "cp_district_abbr" : { "$ref" : "#/components/schemas/UserContactsCp_district_abbrResourceAttribute", "exampleSetFlag" : false }, "sales_phone_no" : { "$ref" : "#/components/schemas/UserContactsSales_phone_noResourceAttribute", "exampleSetFlag" : false }, "usic_contact_id" : { "$ref" : "#/components/schemas/UserContactsUsic_contact_idResourceAttribute", "exampleSetFlag" : false }, "cp_user_name" : { "$ref" : "#/components/schemas/UserContactsCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "cp_district_code" : { "$ref" : "#/components/schemas/UserContactsCp_district_codeResourceAttribute", "exampleSetFlag" : false }, "general_email" : { "$ref" : "#/components/schemas/UserContactsGeneral_emailResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserContactsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "address_line3" : { "$ref" : "#/components/schemas/UserContactsAddress_line3ResourceAttribute", "exampleSetFlag" : false }, "address_line2" : { "$ref" : "#/components/schemas/UserContactsAddress_line2ResourceAttribute", "exampleSetFlag" : false }, "address_line1" : { "$ref" : "#/components/schemas/UserContactsAddress_line1ResourceAttribute", "exampleSetFlag" : false }, "it_support" : { "$ref" : "#/components/schemas/UserContactsIt_supportResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserContactsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/UserContactsStateResourceAttribute", "exampleSetFlag" : false }, "dm_phone_no" : { "$ref" : "#/components/schemas/UserContactsDm_phone_noResourceAttribute", "exampleSetFlag" : false }, "it_support_phone_no" : { "$ref" : "#/components/schemas/UserContactsIt_support_phone_noResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserContactsCp_user_idResourceAttribute", "exampleSetFlag" : false }, "dm_name" : { "$ref" : "#/components/schemas/UserContactsDm_nameResourceAttribute", "exampleSetFlag" : false }, "rd_email" : { "$ref" : "#/components/schemas/UserContactsRd_emailResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UserContactsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "rd_name" : { "$ref" : "#/components/schemas/UserContactsRd_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserContactsCreated_byResourceAttribute", "exampleSetFlag" : false }, "hr_phone_no" : { "$ref" : "#/components/schemas/UserContactsHr_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_contact" : { "$ref" : "#/components/schemas/UserContactsGeneral_contactResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserContactsCreated_onResourceAttribute", "exampleSetFlag" : false }, "sales_email" : { "$ref" : "#/components/schemas/UserContactsSales_emailResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UserContactsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "dm_email" : { "$ref" : "#/components/schemas/UserContactsDm_emailResourceAttribute", "exampleSetFlag" : false }, "rd_phone_no" : { "$ref" : "#/components/schemas/UserContactsRd_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_phone_no" : { "$ref" : "#/components/schemas/UserContactsGeneral_phone_noResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserContactsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessViewPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserDataAccessViewPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/UserDataAccessViewDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UserDataAccessViewDistrict_idResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/UserDataAccessViewRegionResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/UserDataAccessViewSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/UserDataAccessViewEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserDataAccessViewPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserDataAccessViewResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessViewResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userDataAccessView)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userDataAccessView" ] }, "id" : { "$ref" : "#/components/schemas/UserDataAccessViewIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserDataAccessViewResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserDataAccessViewSup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessViewPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userDataAccessView)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userDataAccessView" ] }, "id" : { "$ref" : "#/components/schemas/UserDataAccessViewIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessViewResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserDataAccessViewEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserDataAccessViewIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserDataAccessViewDistrict_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessViewRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessViewResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserDataAccessViewResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserDataAccessViewPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessViewResourcePostAttributes", "exampleSetFlag" : false } ] }, "UserDataAccessViewResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/UserDataAccessViewDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UserDataAccessViewDistrict_idResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/UserDataAccessViewRegionResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/UserDataAccessViewSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/UserDataAccessViewEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserDataAccessViewResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessViewResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessViewResourceLinks", "exampleSetFlag" : false } ] }, "UserDataAccessViewResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessViewResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "district_name" : { "$ref" : "#/components/schemas/UserDataAccessViewDistrict_nameResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UserDataAccessViewDistrict_idResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/UserDataAccessViewRegionResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/UserDataAccessViewSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/UserDataAccessViewEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessViewPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessViewResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userDataAccessView/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessesDistResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserDataAccessesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/UserDataAccessesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "all_districts" : { "$ref" : "#/components/schemas/UserDataAccessesAll_districtsResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/UserDataAccessesApplication_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserDataAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserDataAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "all_supgroups" : { "$ref" : "#/components/schemas/UserDataAccessesAll_supgroupsResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/UserDataAccessesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserDataAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UserDataAccessesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/UserDataAccessesSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/UserDataAccessesEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserDataAccessesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserDataAccessesEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserDataAccessesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "application" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userDataAccesses/{id}/relationships/application" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userDataAccesses/{id}/application" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userDataAccesses/{id}/relationships/dist" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userDataAccesses/{id}/dist" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userDataAccesses/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userDataAccesses/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesAll_supgroupsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UserDataAccessesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessesResourceLinks", "exampleSetFlag" : false } ] }, "UserDataAccessesApplication_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserDataAccessesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserDataAccessesAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessesAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessesApplicationResourceAttribute" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserDataAccessesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserDataAccessesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userDataAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userDataAccesses" ] }, "id" : { "$ref" : "#/components/schemas/UserDataAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserDataAccessesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/UserDataAccessesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "all_districts" : { "$ref" : "#/components/schemas/UserDataAccessesAll_districtsResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/UserDataAccessesApplication_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserDataAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserDataAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "all_supgroups" : { "$ref" : "#/components/schemas/UserDataAccessesAll_supgroupsResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/UserDataAccessesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UserDataAccessesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/UserDataAccessesSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/UserDataAccessesEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "application" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "application" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/ApplicationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserDataAccessesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserDataAccessesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserDataAccessesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/UserDataAccessesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "all_districts" : { "$ref" : "#/components/schemas/UserDataAccessesAll_districtsResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/UserDataAccessesApplication_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserDataAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserDataAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute5ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserDataAccessesCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute4ResourceAttribute", "exampleSetFlag" : false }, "all_supgroups" : { "$ref" : "#/components/schemas/UserDataAccessesAll_supgroupsResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/UserDataAccessesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute1ResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserDataAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute3ResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UserDataAccessesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/UserDataAccessesAttribute2ResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/UserDataAccessesSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/UserDataAccessesEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesSup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessesAll_districtsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UserDataAccessesAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserDataAccessesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserDataAccessesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userDataAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userDataAccesses" ] }, "id" : { "$ref" : "#/components/schemas/UserDataAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userDataAccesses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserDataAccessesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserDataAccessesEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserDataAccessesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserDataAccessesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserDataAccessesResourcePostRelationships", "exampleSetFlag" : false } ] }, "UserEmployeeAccessesEff_sup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userEmployeeAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userEmployeeAccesses" ] }, "id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserEmployeeAccessesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "reason" : { "$ref" : "#/components/schemas/UserEmployeeAccessesReasonResourceAttribute", "exampleSetFlag" : false }, "estimated_return_date" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEstimated_return_dateResourceAttribute", "exampleSetFlag" : false }, "district_abbr" : { "$ref" : "#/components/schemas/UserEmployeeAccessesDistrict_abbrResourceAttribute", "exampleSetFlag" : false }, "sup_emp_id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesSup_emp_idResourceAttribute", "exampleSetFlag" : false }, "exclusion_code" : { "$ref" : "#/components/schemas/UserEmployeeAccessesExclusion_codeResourceAttribute", "exampleSetFlag" : false }, "eff_district_abbr" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEff_district_abbrResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserEmployeeAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_code" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEff_sup_group_codeResourceAttribute", "exampleSetFlag" : false }, "legal_name_last" : { "$ref" : "#/components/schemas/UserEmployeeAccessesLegal_name_lastResourceAttribute", "exampleSetFlag" : false }, "effective_date" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEffective_dateResourceAttribute", "exampleSetFlag" : false }, "action" : { "$ref" : "#/components/schemas/UserEmployeeAccessesActionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserEmployeeAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "legal_name" : { "$ref" : "#/components/schemas/UserEmployeeAccessesLegal_nameResourceAttribute", "exampleSetFlag" : false }, "job_code" : { "$ref" : "#/components/schemas/UserEmployeeAccessesJob_codeResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/UserEmployeeAccessesStateResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEmailResourceAttribute", "exampleSetFlag" : false }, "eff_region" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEff_regionResourceAttribute", "exampleSetFlag" : false }, "sup_group_id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesSup_group_idResourceAttribute", "exampleSetFlag" : false }, "legal_name_first" : { "$ref" : "#/components/schemas/UserEmployeeAccessesLegal_name_firstResourceAttribute", "exampleSetFlag" : false }, "eff_state" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEff_stateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserEmployeeAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "accessing_emp_id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesAccessing_emp_idResourceAttribute", "exampleSetFlag" : false }, "active_status" : { "$ref" : "#/components/schemas/UserEmployeeAccessesActive_statusResourceAttribute", "exampleSetFlag" : false }, "eff_supervisor" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEff_supervisorResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserEmployeeAccessesCreated_onResourceAttribute", "exampleSetFlag" : false }, "district" : { "$ref" : "#/components/schemas/UserEmployeeAccessesDistrictResourceAttribute", "exampleSetFlag" : false }, "eff_sup_group_id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEff_sup_group_idResourceAttribute", "exampleSetFlag" : false }, "eff_district_id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEff_district_idResourceAttribute", "exampleSetFlag" : false }, "position" : { "$ref" : "#/components/schemas/UserEmployeeAccessesPositionResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "emp_type" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEmp_typeResourceAttribute", "exampleSetFlag" : false }, "region" : { "$ref" : "#/components/schemas/UserEmployeeAccessesRegionResourceAttribute", "exampleSetFlag" : false }, "eff_sup_emp_id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEff_sup_emp_idResourceAttribute", "exampleSetFlag" : false }, "sup_group_code" : { "$ref" : "#/components/schemas/UserEmployeeAccessesSup_group_codeResourceAttribute", "exampleSetFlag" : false }, "supervisor" : { "$ref" : "#/components/schemas/UserEmployeeAccessesSupervisorResourceAttribute", "exampleSetFlag" : false }, "eff_district" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEff_districtResourceAttribute", "exampleSetFlag" : false }, "emp_id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesEmp_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserEmployeeAccessesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserEmployeeAccessesEff_regionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesEffective_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserEmployeeAccessesPositionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesEmp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesEff_district_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesLegal_name_lastResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesEff_supervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserEmployeeAccessesEff_sup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesSup_group_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesSupervisorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userEmployeeAccesses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserEmployeeAccessesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userEmployeeAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userEmployeeAccesses" ] }, "id" : { "$ref" : "#/components/schemas/UserEmployeeAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserEmployeeAccessesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserEmployeeAccessesExclusion_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesEmp_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserEmployeeAccessesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserEmployeeAccessesReasonResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesJob_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesLegal_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesDistrict_abbrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesEff_sup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserEmployeeAccessesPostResourceReference", "exampleSetFlag" : false } ] }, "UserEmployeeAccessesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserEmployeeAccessesRegionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesAccessing_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesLegal_name_firstResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserEmployeeAccessesSup_emp_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesEstimated_return_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserEmployeeAccessesEff_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesEff_districtResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesSup_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserEmployeeAccessesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserEmployeeAccessesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserEmployeeAccessesDistrictResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesActive_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesEff_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserEmployeeAccessesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserEmployeeAccessesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceLinks", "exampleSetFlag" : false } ] }, "UserEmployeeAccessesActionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserEmployeeAccessesEmailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userLogins/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserLoginsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserLoginsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserLoginsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserLoginsResourceLinks", "exampleSetFlag" : false } ] }, "UserLoginsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserLoginsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserLoginsResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserLoginsResourcePostRelationships", "exampleSetFlag" : false } ] }, "UserLoginsUser_platformResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserLoginsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserLoginsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserLoginsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userLogins/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userLogins/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userLogins)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userLogins" ] }, "id" : { "$ref" : "#/components/schemas/UserLoginsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserLoginsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "screen_width" : { "$ref" : "#/components/schemas/UserLoginsScreen_widthResourceAttribute", "exampleSetFlag" : false }, "user_platform" : { "$ref" : "#/components/schemas/UserLoginsUser_platformResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/UserLoginsSession_idResourceAttribute", "exampleSetFlag" : false }, "login_date" : { "$ref" : "#/components/schemas/UserLoginsLogin_dateResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/UserLoginsApplication_idResourceAttribute", "exampleSetFlag" : false }, "minor_version" : { "$ref" : "#/components/schemas/UserLoginsMinor_versionResourceAttribute", "exampleSetFlag" : false }, "browser_name" : { "$ref" : "#/components/schemas/UserLoginsBrowser_nameResourceAttribute", "exampleSetFlag" : false }, "major_version" : { "$ref" : "#/components/schemas/UserLoginsMajor_versionResourceAttribute", "exampleSetFlag" : false }, "screen_height" : { "$ref" : "#/components/schemas/UserLoginsScreen_heightResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/UserLoginsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/UserLoginsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/UserLoginsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/UserLoginsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/UserLoginsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/UserLoginsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "screen_width" : { "$ref" : "#/components/schemas/UserLoginsScreen_widthResourceAttribute", "exampleSetFlag" : false }, "user_platform" : { "$ref" : "#/components/schemas/UserLoginsUser_platformResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/UserLoginsSession_idResourceAttribute", "exampleSetFlag" : false }, "login_date" : { "$ref" : "#/components/schemas/UserLoginsLogin_dateResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/UserLoginsApplication_idResourceAttribute", "exampleSetFlag" : false }, "minor_version" : { "$ref" : "#/components/schemas/UserLoginsMinor_versionResourceAttribute", "exampleSetFlag" : false }, "browser_name" : { "$ref" : "#/components/schemas/UserLoginsBrowser_nameResourceAttribute", "exampleSetFlag" : false }, "major_version" : { "$ref" : "#/components/schemas/UserLoginsMajor_versionResourceAttribute", "exampleSetFlag" : false }, "screen_height" : { "$ref" : "#/components/schemas/UserLoginsScreen_heightResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/UserLoginsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/UserLoginsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/UserLoginsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/UserLoginsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/UserLoginsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/UserLoginsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsSession_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserLoginsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserLoginsMajor_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserLoginsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsMinor_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserLoginsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsBrowser_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsApplication_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserLoginsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserLoginsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "screen_width" : { "$ref" : "#/components/schemas/UserLoginsScreen_widthResourceAttribute", "exampleSetFlag" : false }, "user_platform" : { "$ref" : "#/components/schemas/UserLoginsUser_platformResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/UserLoginsSession_idResourceAttribute", "exampleSetFlag" : false }, "login_date" : { "$ref" : "#/components/schemas/UserLoginsLogin_dateResourceAttribute", "exampleSetFlag" : false }, "application_id" : { "$ref" : "#/components/schemas/UserLoginsApplication_idResourceAttribute", "exampleSetFlag" : false }, "minor_version" : { "$ref" : "#/components/schemas/UserLoginsMinor_versionResourceAttribute", "exampleSetFlag" : false }, "browser_name" : { "$ref" : "#/components/schemas/UserLoginsBrowser_nameResourceAttribute", "exampleSetFlag" : false }, "major_version" : { "$ref" : "#/components/schemas/UserLoginsMajor_versionResourceAttribute", "exampleSetFlag" : false }, "screen_height" : { "$ref" : "#/components/schemas/UserLoginsScreen_heightResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/UserLoginsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/UserLoginsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/UserLoginsEmployee_idResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/UserLoginsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/UserLoginsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/UserLoginsAttribute2ResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employee" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserLoginsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserLoginsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserLoginsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userLogins)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userLogins" ] }, "id" : { "$ref" : "#/components/schemas/UserLoginsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsScreen_heightResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserLoginsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserLoginsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserLoginsResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserLoginsResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserLoginsLogin_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserLoginsScreen_widthResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserLoginsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserPermissionsEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserPermissionsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserPermissionsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserPermissionsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserPermissionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserPermissionsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserPermissionsResourceLinks", "exampleSetFlag" : false } ] }, "UserPermissionsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserPermissionsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserPermissionsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserPermissionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/UserPermissionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "cp_permission_id" : { "$ref" : "#/components/schemas/UserPermissionsCp_permission_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserPermissionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UserPermissionsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserPermissionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserPermissionsCp_user_idResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UserPermissionsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserPermissionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserPermissionsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserPermissionsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserPermissionsCp_permission_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserPermissionsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserPermissionsCp_user_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserPermissionsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserPermissionsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserPermissionsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userPermissions/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userPermissions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userPermissions" ] }, "id" : { "$ref" : "#/components/schemas/UserPermissionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userPermissions)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userPermissions" ] }, "id" : { "$ref" : "#/components/schemas/UserPermissionsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserPermissionsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserPermissionsResourcePostAttributes", "exampleSetFlag" : false } ] }, "UserPermissionsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserPermissionsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserPermissionsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserPermissionsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserPermissionsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserPermissionsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/UserPermissionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "cp_permission_id" : { "$ref" : "#/components/schemas/UserPermissionsCp_permission_idResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UserPermissionsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserPermissionsCp_user_idResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UserPermissionsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserPermissionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserPermissionsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/UserPermissionsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "cp_permission_id" : { "$ref" : "#/components/schemas/UserPermissionsCp_permission_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserPermissionsCreated_onResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UserPermissionsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserPermissionsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserPermissionsCp_user_idResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UserPermissionsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserPermissionsCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesEmail_addressResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserProfilesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userProfiles/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesMobile_phoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserProfilesCp_passwordResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserProfilesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userProfiles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userProfiles" ] }, "id" : { "$ref" : "#/components/schemas/UserProfilesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesCp_user_nameResourceAttribute" : { "type" : "string", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserProfilesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserProfilesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserProfilesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserProfilesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserProfilesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserProfilesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserProfilesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesPreferred_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserProfilesLast_logged_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserProfilesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "password_date" : { "$ref" : "#/components/schemas/UserProfilesPassword_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserProfilesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "email_address" : { "$ref" : "#/components/schemas/UserProfilesEmail_addressResourceAttribute", "exampleSetFlag" : false }, "mobile_phone" : { "$ref" : "#/components/schemas/UserProfilesMobile_phoneResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/UserProfilesLast_nameResourceAttribute", "exampleSetFlag" : false }, "last_logged_on" : { "$ref" : "#/components/schemas/UserProfilesLast_logged_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserProfilesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "middle_name" : { "$ref" : "#/components/schemas/UserProfilesMiddle_nameResourceAttribute", "exampleSetFlag" : false }, "cp_password" : { "$ref" : "#/components/schemas/UserProfilesCp_passwordResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/UserProfilesFirst_nameResourceAttribute", "exampleSetFlag" : false }, "preferred_name" : { "$ref" : "#/components/schemas/UserProfilesPreferred_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesFirst_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserProfilesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userProfiles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userProfiles" ] }, "id" : { "$ref" : "#/components/schemas/UserProfilesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserProfilesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesMiddle_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserProfilesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserProfilesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserProfilesResourcePostAttributes", "exampleSetFlag" : false } ] }, "UserProfilesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserProfilesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserProfilesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserProfilesResourceLinks", "exampleSetFlag" : false } ] }, "UserProfilesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserProfilesCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "password_date" : { "$ref" : "#/components/schemas/UserProfilesPassword_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserProfilesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "email_address" : { "$ref" : "#/components/schemas/UserProfilesEmail_addressResourceAttribute", "exampleSetFlag" : false }, "mobile_phone" : { "$ref" : "#/components/schemas/UserProfilesMobile_phoneResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/UserProfilesLast_nameResourceAttribute", "exampleSetFlag" : false }, "last_logged_on" : { "$ref" : "#/components/schemas/UserProfilesLast_logged_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserProfilesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "middle_name" : { "$ref" : "#/components/schemas/UserProfilesMiddle_nameResourceAttribute", "exampleSetFlag" : false }, "cp_password" : { "$ref" : "#/components/schemas/UserProfilesCp_passwordResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/UserProfilesFirst_nameResourceAttribute", "exampleSetFlag" : false }, "preferred_name" : { "$ref" : "#/components/schemas/UserProfilesPreferred_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserProfilesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesPassword_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserProfilesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserProfilesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserProfilesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserProfilesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "password_date" : { "$ref" : "#/components/schemas/UserProfilesPassword_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserProfilesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "email_address" : { "$ref" : "#/components/schemas/UserProfilesEmail_addressResourceAttribute", "exampleSetFlag" : false }, "mobile_phone" : { "$ref" : "#/components/schemas/UserProfilesMobile_phoneResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/UserProfilesLast_nameResourceAttribute", "exampleSetFlag" : false }, "last_logged_on" : { "$ref" : "#/components/schemas/UserProfilesLast_logged_onResourceAttribute", "exampleSetFlag" : false }, "middle_name" : { "$ref" : "#/components/schemas/UserProfilesMiddle_nameResourceAttribute", "exampleSetFlag" : false }, "cp_password" : { "$ref" : "#/components/schemas/UserProfilesCp_passwordResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/UserProfilesFirst_nameResourceAttribute", "exampleSetFlag" : false }, "preferred_name" : { "$ref" : "#/components/schemas/UserProfilesPreferred_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserProfilesLast_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserProfilesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserProfilesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserProfilesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserRequestsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRequestsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRequestsResourceLinks", "exampleSetFlag" : false } ] }, "UserRequestsRequest_user_agentResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsAttribute4ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "response_status" : { "$ref" : "#/components/schemas/UserRequestsResponse_statusResourceAttribute", "exampleSetFlag" : false }, "request_x_real_ip" : { "$ref" : "#/components/schemas/UserRequestsRequest_x_real_ipResourceAttribute", "exampleSetFlag" : false }, "user_platform" : { "$ref" : "#/components/schemas/UserRequestsUser_platformResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/UserRequestsSession_idResourceAttribute", "exampleSetFlag" : false }, "request_method" : { "$ref" : "#/components/schemas/UserRequestsRequest_methodResourceAttribute", "exampleSetFlag" : false }, "request_url" : { "$ref" : "#/components/schemas/UserRequestsRequest_urlResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserRequestsCreated_byResourceAttribute", "exampleSetFlag" : false }, "request_user_agent" : { "$ref" : "#/components/schemas/UserRequestsRequest_user_agentResourceAttribute", "exampleSetFlag" : false }, "request_header_crnk_compact" : { "$ref" : "#/components/schemas/UserRequestsRequest_header_crnk_compactResourceAttribute", "exampleSetFlag" : false }, "browser_name" : { "$ref" : "#/components/schemas/UserRequestsBrowser_nameResourceAttribute", "exampleSetFlag" : false }, "request_content_type" : { "$ref" : "#/components/schemas/UserRequestsRequest_content_typeResourceAttribute", "exampleSetFlag" : false }, "major_version" : { "$ref" : "#/components/schemas/UserRequestsMajor_versionResourceAttribute", "exampleSetFlag" : false }, "response_content_type" : { "$ref" : "#/components/schemas/UserRequestsResponse_content_typeResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/UserRequestsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/UserRequestsUser_idResourceAttribute", "exampleSetFlag" : false }, "request_user" : { "$ref" : "#/components/schemas/UserRequestsRequest_userResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/UserRequestsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserRequestsCreated_onResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/UserRequestsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/UserRequestsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "request_query_string" : { "$ref" : "#/components/schemas/UserRequestsRequest_query_stringResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/UserRequestsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "request_time_ms" : { "$ref" : "#/components/schemas/UserRequestsRequest_time_msResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userRequests)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userRequests" ] }, "id" : { "$ref" : "#/components/schemas/UserRequestsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsRequest_userResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsResponse_content_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsRequest_header_crnk_compactResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UserRequestsRequest_content_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserRequestsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsRequest_x_real_ipResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsRequest_time_msResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserRequestsMajor_versionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsAttribute2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsResponse_statusResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserRequestsAttribute3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/shareddata/1.0/userRequests/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsSession_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsBrowser_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserRequestsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsAttribute1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsRequest_urlResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "response_status" : { "$ref" : "#/components/schemas/UserRequestsResponse_statusResourceAttribute", "exampleSetFlag" : false }, "request_x_real_ip" : { "$ref" : "#/components/schemas/UserRequestsRequest_x_real_ipResourceAttribute", "exampleSetFlag" : false }, "user_platform" : { "$ref" : "#/components/schemas/UserRequestsUser_platformResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/UserRequestsSession_idResourceAttribute", "exampleSetFlag" : false }, "request_method" : { "$ref" : "#/components/schemas/UserRequestsRequest_methodResourceAttribute", "exampleSetFlag" : false }, "request_url" : { "$ref" : "#/components/schemas/UserRequestsRequest_urlResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserRequestsCreated_byResourceAttribute", "exampleSetFlag" : false }, "request_user_agent" : { "$ref" : "#/components/schemas/UserRequestsRequest_user_agentResourceAttribute", "exampleSetFlag" : false }, "request_header_crnk_compact" : { "$ref" : "#/components/schemas/UserRequestsRequest_header_crnk_compactResourceAttribute", "exampleSetFlag" : false }, "browser_name" : { "$ref" : "#/components/schemas/UserRequestsBrowser_nameResourceAttribute", "exampleSetFlag" : false }, "request_content_type" : { "$ref" : "#/components/schemas/UserRequestsRequest_content_typeResourceAttribute", "exampleSetFlag" : false }, "major_version" : { "$ref" : "#/components/schemas/UserRequestsMajor_versionResourceAttribute", "exampleSetFlag" : false }, "response_content_type" : { "$ref" : "#/components/schemas/UserRequestsResponse_content_typeResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/UserRequestsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/UserRequestsUser_idResourceAttribute", "exampleSetFlag" : false }, "request_user" : { "$ref" : "#/components/schemas/UserRequestsRequest_userResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/UserRequestsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/UserRequestsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/UserRequestsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "request_query_string" : { "$ref" : "#/components/schemas/UserRequestsRequest_query_stringResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/UserRequestsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "request_time_ms" : { "$ref" : "#/components/schemas/UserRequestsRequest_time_msResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsRequest_query_stringResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsUser_platformResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserRequestsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRequestsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "response_status" : { "$ref" : "#/components/schemas/UserRequestsResponse_statusResourceAttribute", "exampleSetFlag" : false }, "request_x_real_ip" : { "$ref" : "#/components/schemas/UserRequestsRequest_x_real_ipResourceAttribute", "exampleSetFlag" : false }, "user_platform" : { "$ref" : "#/components/schemas/UserRequestsUser_platformResourceAttribute", "exampleSetFlag" : false }, "session_id" : { "$ref" : "#/components/schemas/UserRequestsSession_idResourceAttribute", "exampleSetFlag" : false }, "request_method" : { "$ref" : "#/components/schemas/UserRequestsRequest_methodResourceAttribute", "exampleSetFlag" : false }, "request_url" : { "$ref" : "#/components/schemas/UserRequestsRequest_urlResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserRequestsCreated_byResourceAttribute", "exampleSetFlag" : false }, "request_user_agent" : { "$ref" : "#/components/schemas/UserRequestsRequest_user_agentResourceAttribute", "exampleSetFlag" : false }, "request_header_crnk_compact" : { "$ref" : "#/components/schemas/UserRequestsRequest_header_crnk_compactResourceAttribute", "exampleSetFlag" : false }, "browser_name" : { "$ref" : "#/components/schemas/UserRequestsBrowser_nameResourceAttribute", "exampleSetFlag" : false }, "request_content_type" : { "$ref" : "#/components/schemas/UserRequestsRequest_content_typeResourceAttribute", "exampleSetFlag" : false }, "major_version" : { "$ref" : "#/components/schemas/UserRequestsMajor_versionResourceAttribute", "exampleSetFlag" : false }, "response_content_type" : { "$ref" : "#/components/schemas/UserRequestsResponse_content_typeResourceAttribute", "exampleSetFlag" : false }, "attribute5" : { "$ref" : "#/components/schemas/UserRequestsAttribute5ResourceAttribute", "exampleSetFlag" : false }, "user_id" : { "$ref" : "#/components/schemas/UserRequestsUser_idResourceAttribute", "exampleSetFlag" : false }, "request_user" : { "$ref" : "#/components/schemas/UserRequestsRequest_userResourceAttribute", "exampleSetFlag" : false }, "attribute4" : { "$ref" : "#/components/schemas/UserRequestsAttribute4ResourceAttribute", "exampleSetFlag" : false }, "attribute1" : { "$ref" : "#/components/schemas/UserRequestsAttribute1ResourceAttribute", "exampleSetFlag" : false }, "attribute3" : { "$ref" : "#/components/schemas/UserRequestsAttribute3ResourceAttribute", "exampleSetFlag" : false }, "request_query_string" : { "$ref" : "#/components/schemas/UserRequestsRequest_query_stringResourceAttribute", "exampleSetFlag" : false }, "attribute2" : { "$ref" : "#/components/schemas/UserRequestsAttribute2ResourceAttribute", "exampleSetFlag" : false }, "request_time_ms" : { "$ref" : "#/components/schemas/UserRequestsRequest_time_msResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRequestsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserRequestsAttribute5ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserRequestsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRequestsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserRequestsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRequestsResourcePostAttributes", "exampleSetFlag" : false } ] }, "UserRequestsRequest_methodResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRequestsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userRequests)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userRequests" ] }, "id" : { "$ref" : "#/components/schemas/UserRequestsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRequestsUser_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserRequestsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserRequestsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserRequestsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserRequestsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRequestsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userRoleAssignments)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userRoleAssignments" ] }, "id" : { "$ref" : "#/components/schemas/UserRoleAssignmentsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/userRoleAssignments/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/UserRoleAssignmentsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "peoplesoft_id" : { "$ref" : "#/components/schemas/UserRoleAssignmentsPeoplesoft_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserRoleAssignmentsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "role_id" : { "$ref" : "#/components/schemas/UserRoleAssignmentsRole_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserRoleAssignmentsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserRoleAssignmentsCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/UserRoleAssignmentsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRoleAssignmentsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRoleAssignmentsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserRoleAssignmentsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userRoleAssignments)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userRoleAssignments" ] }, "id" : { "$ref" : "#/components/schemas/UserRoleAssignmentsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserRoleAssignmentsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/UserRoleAssignmentsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "peoplesoft_id" : { "$ref" : "#/components/schemas/UserRoleAssignmentsPeoplesoft_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserRoleAssignmentsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "role_id" : { "$ref" : "#/components/schemas/UserRoleAssignmentsRole_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserRoleAssignmentsCreated_onResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserRoleAssignmentsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserRoleAssignmentsCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/UserRoleAssignmentsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsRole_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserRoleAssignmentsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRoleAssignmentsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserRoleAssignmentsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserRoleAssignmentsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserRoleAssignmentsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserRoleAssignmentsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserRoleAssignmentsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRoleAssignmentsResourcePostAttributes", "exampleSetFlag" : false } ] }, "UserRoleAssignmentsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRoleAssignmentsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsPeoplesoft_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserRoleAssignmentsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/UserRoleAssignmentsEnd_dateResourceAttribute", "exampleSetFlag" : false }, "peoplesoft_id" : { "$ref" : "#/components/schemas/UserRoleAssignmentsPeoplesoft_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserRoleAssignmentsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "role_id" : { "$ref" : "#/components/schemas/UserRoleAssignmentsRole_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserRoleAssignmentsCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/UserRoleAssignmentsStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRoleAssignmentsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserRoleAssignmentsStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserRoleAssignmentsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceLinks", "exampleSetFlag" : false } ] }, "UserRoleAssignmentsUsrRoleResourceAttribute" : { "$ref" : "#/components/schemas/UsrRolesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UserRoleAssignmentsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "usrRole" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/userRoleAssignments/{id}/relationships/usrRole" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/userRoleAssignments/{id}/usrRole" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrRolesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsrRolesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userRoles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userRoles" ] }, "id" : { "$ref" : "#/components/schemas/UserRolesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRolesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRolesRoleAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "UserRolesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserRolesEffective_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserRolesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userRoles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userRoles" ] }, "id" : { "$ref" : "#/components/schemas/UserRolesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRolesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserRolesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserRolesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRolesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/UserRolesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserRolesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UserRolesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/UserRolesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/UserRolesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserRolesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserRolesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "roleAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/userRoles/{id}/relationships/roleAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/userRoles/{id}/roleAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/RoleAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/UserRolesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserRolesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/UserRolesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/UserRolesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UserRolesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserRolesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRolesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserRolesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRolesResourcePostAttributes", "exampleSetFlag" : false } ] }, "UserRolesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesEffective_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UserRolesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserRolesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UserRolesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserRolesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserRolesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserRolesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserRolesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRolesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRolesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserRolesResourceLinks", "exampleSetFlag" : false } ] }, "UserRolesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/userRoles/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserRolesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "effective_end_date" : { "$ref" : "#/components/schemas/UserRolesEffective_end_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UserRolesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/UserRolesNameResourceAttribute", "exampleSetFlag" : false }, "effective_start_date" : { "$ref" : "#/components/schemas/UserRolesEffective_start_dateResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UserRolesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesIdResourceAttribute" : { "type" : "object", "properties" : { "cp_user_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "state" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserStatesCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/UserStatesStateResourceAttribute", "exampleSetFlag" : false }, "cp_user_id" : { "$ref" : "#/components/schemas/UserStatesCp_user_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserStatesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserStatesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserStatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesCp_user_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserStatesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserStatesCp_user_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesCp_user_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UserStatesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UserStatesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UserStatesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userStates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userStates" ] }, "id" : { "$ref" : "#/components/schemas/UserStatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UserStatesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cp_user_name" : { "$ref" : "#/components/schemas/UserStatesCp_user_nameResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserStatesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserStatesResourcePostAttributes", "exampleSetFlag" : false } ] }, "UserStatesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/userStates/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (userStates)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "userStates" ] }, "id" : { "$ref" : "#/components/schemas/UserStatesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserStatesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UserStatesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserStatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserStatesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UserStatesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UserStatesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UserStatesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserStatesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UserStatesResourceLinks", "exampleSetFlag" : false } ] }, "UsersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersAccount_domainsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UsersCp_user_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersShow_damagesResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "logo_id" : { "$ref" : "#/components/schemas/UsersLogo_idResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UsersEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "receive_notifications" : { "$ref" : "#/components/schemas/UsersReceive_notificationsResourceAttribute", "exampleSetFlag" : false }, "allow_exports" : { "$ref" : "#/components/schemas/UsersAllow_exportsResourceAttribute", "exampleSetFlag" : false }, "cp_admin" : { "$ref" : "#/components/schemas/UsersCp_adminResourceAttribute", "exampleSetFlag" : false }, "show_responses" : { "$ref" : "#/components/schemas/UsersShow_responsesResourceAttribute", "exampleSetFlag" : false }, "cp_user_name" : { "$ref" : "#/components/schemas/UsersCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "managed_services" : { "$ref" : "#/components/schemas/UsersManaged_servicesResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UsersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "mobile_phone" : { "$ref" : "#/components/schemas/UsersMobile_phoneResourceAttribute", "exampleSetFlag" : false }, "last_logged_on" : { "$ref" : "#/components/schemas/UsersLast_logged_onResourceAttribute", "exampleSetFlag" : false }, "ms_admin" : { "$ref" : "#/components/schemas/UsersMs_adminResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UsersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attachments_with_notifications" : { "$ref" : "#/components/schemas/UsersAttachments_with_notificationsResourceAttribute", "exampleSetFlag" : false }, "account_domains" : { "$ref" : "#/components/schemas/UsersAccount_domainsResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UsersEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/UsersFirst_nameResourceAttribute", "exampleSetFlag" : false }, "show_managed_services" : { "$ref" : "#/components/schemas/UsersShow_managed_servicesResourceAttribute", "exampleSetFlag" : false }, "show_screenshots" : { "$ref" : "#/components/schemas/UsersShow_screenshotsResourceAttribute", "exampleSetFlag" : false }, "export_gps" : { "$ref" : "#/components/schemas/UsersExport_gpsResourceAttribute", "exampleSetFlag" : false }, "account_admin" : { "$ref" : "#/components/schemas/UsersAccount_adminResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/UsersLast_nameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/UsersActiveResourceAttribute", "exampleSetFlag" : false }, "middle_name" : { "$ref" : "#/components/schemas/UsersMiddle_nameResourceAttribute", "exampleSetFlag" : false }, "cp_password" : { "$ref" : "#/components/schemas/UsersCp_passwordResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/UsersDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UsersCreated_byResourceAttribute", "exampleSetFlag" : false }, "password_date" : { "$ref" : "#/components/schemas/UsersPassword_dateResourceAttribute", "exampleSetFlag" : false }, "nda_signed" : { "$ref" : "#/components/schemas/UsersNda_signedResourceAttribute", "exampleSetFlag" : false }, "show_damages" : { "$ref" : "#/components/schemas/UsersShow_damagesResourceAttribute", "exampleSetFlag" : false }, "email_address" : { "$ref" : "#/components/schemas/UsersEmail_addressResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UsersCreated_onResourceAttribute", "exampleSetFlag" : false }, "expiration_cycle" : { "$ref" : "#/components/schemas/UsersExpiration_cycleResourceAttribute", "exampleSetFlag" : false }, "show_tickets" : { "$ref" : "#/components/schemas/UsersShow_ticketsResourceAttribute", "exampleSetFlag" : false }, "show_gps" : { "$ref" : "#/components/schemas/UsersShow_gpsResourceAttribute", "exampleSetFlag" : false }, "preferred_name" : { "$ref" : "#/components/schemas/UsersPreferred_nameResourceAttribute", "exampleSetFlag" : false }, "show_history" : { "$ref" : "#/components/schemas/UsersShow_historyResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UsersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersSessionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "UsersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (users)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "users" ] }, "id" : { "$ref" : "#/components/schemas/UsersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersShow_managed_servicesResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersMs_adminResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersLast_logged_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UsersEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UsersUserAccessesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "UsersResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "sessions" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerAccounts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerContracts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersShow_historyResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersShow_responsesResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsersResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsersResourcePostRelationships", "exampleSetFlag" : false } ] }, "UsersDisplay_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (users)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "users" ] }, "id" : { "$ref" : "#/components/schemas/UsersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UsersShow_gpsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersAttachments_with_notificationsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersShow_screenshotsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "logo_id" : { "$ref" : "#/components/schemas/UsersLogo_idResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UsersEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "receive_notifications" : { "$ref" : "#/components/schemas/UsersReceive_notificationsResourceAttribute", "exampleSetFlag" : false }, "allow_exports" : { "$ref" : "#/components/schemas/UsersAllow_exportsResourceAttribute", "exampleSetFlag" : false }, "cp_admin" : { "$ref" : "#/components/schemas/UsersCp_adminResourceAttribute", "exampleSetFlag" : false }, "show_responses" : { "$ref" : "#/components/schemas/UsersShow_responsesResourceAttribute", "exampleSetFlag" : false }, "cp_user_name" : { "$ref" : "#/components/schemas/UsersCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "managed_services" : { "$ref" : "#/components/schemas/UsersManaged_servicesResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UsersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "mobile_phone" : { "$ref" : "#/components/schemas/UsersMobile_phoneResourceAttribute", "exampleSetFlag" : false }, "last_logged_on" : { "$ref" : "#/components/schemas/UsersLast_logged_onResourceAttribute", "exampleSetFlag" : false }, "ms_admin" : { "$ref" : "#/components/schemas/UsersMs_adminResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UsersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "attachments_with_notifications" : { "$ref" : "#/components/schemas/UsersAttachments_with_notificationsResourceAttribute", "exampleSetFlag" : false }, "account_domains" : { "$ref" : "#/components/schemas/UsersAccount_domainsResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UsersEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/UsersFirst_nameResourceAttribute", "exampleSetFlag" : false }, "show_managed_services" : { "$ref" : "#/components/schemas/UsersShow_managed_servicesResourceAttribute", "exampleSetFlag" : false }, "show_screenshots" : { "$ref" : "#/components/schemas/UsersShow_screenshotsResourceAttribute", "exampleSetFlag" : false }, "export_gps" : { "$ref" : "#/components/schemas/UsersExport_gpsResourceAttribute", "exampleSetFlag" : false }, "account_admin" : { "$ref" : "#/components/schemas/UsersAccount_adminResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/UsersLast_nameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/UsersActiveResourceAttribute", "exampleSetFlag" : false }, "middle_name" : { "$ref" : "#/components/schemas/UsersMiddle_nameResourceAttribute", "exampleSetFlag" : false }, "cp_password" : { "$ref" : "#/components/schemas/UsersCp_passwordResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/UsersDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UsersCreated_byResourceAttribute", "exampleSetFlag" : false }, "password_date" : { "$ref" : "#/components/schemas/UsersPassword_dateResourceAttribute", "exampleSetFlag" : false }, "nda_signed" : { "$ref" : "#/components/schemas/UsersNda_signedResourceAttribute", "exampleSetFlag" : false }, "show_damages" : { "$ref" : "#/components/schemas/UsersShow_damagesResourceAttribute", "exampleSetFlag" : false }, "email_address" : { "$ref" : "#/components/schemas/UsersEmail_addressResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UsersCreated_onResourceAttribute", "exampleSetFlag" : false }, "expiration_cycle" : { "$ref" : "#/components/schemas/UsersExpiration_cycleResourceAttribute", "exampleSetFlag" : false }, "show_tickets" : { "$ref" : "#/components/schemas/UsersShow_ticketsResourceAttribute", "exampleSetFlag" : false }, "show_gps" : { "$ref" : "#/components/schemas/UsersShow_gpsResourceAttribute", "exampleSetFlag" : false }, "preferred_name" : { "$ref" : "#/components/schemas/UsersPreferred_nameResourceAttribute", "exampleSetFlag" : false }, "show_history" : { "$ref" : "#/components/schemas/UsersShow_historyResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersShow_ticketsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersPassword_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UsersLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersManaged_servicesResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UsersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UsersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "sessions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/users/{id}/relationships/sessions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/users/{id}/sessions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerAccounts" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/users/{id}/relationships/customerAccounts" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/users/{id}/customerAccounts" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userAccesses" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/users/{id}/relationships/userAccesses" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/users/{id}/userAccesses" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerContracts" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/users/{id}/relationships/customerContracts" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/users/{id}/customerContracts" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsersResourceLinks", "exampleSetFlag" : false } ] }, "UsersMobile_phoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersFirst_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersCp_passwordResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsersResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsersResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersReceive_notificationsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/users/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "sessions" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/SessionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerAccounts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "userAccesses" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "customerContracts" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersCustomerContractsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "UsersMiddle_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "logo_id" : { "$ref" : "#/components/schemas/UsersLogo_idResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UsersEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "receive_notifications" : { "$ref" : "#/components/schemas/UsersReceive_notificationsResourceAttribute", "exampleSetFlag" : false }, "allow_exports" : { "$ref" : "#/components/schemas/UsersAllow_exportsResourceAttribute", "exampleSetFlag" : false }, "cp_admin" : { "$ref" : "#/components/schemas/UsersCp_adminResourceAttribute", "exampleSetFlag" : false }, "show_responses" : { "$ref" : "#/components/schemas/UsersShow_responsesResourceAttribute", "exampleSetFlag" : false }, "cp_user_name" : { "$ref" : "#/components/schemas/UsersCp_user_nameResourceAttribute", "exampleSetFlag" : false }, "managed_services" : { "$ref" : "#/components/schemas/UsersManaged_servicesResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UsersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "mobile_phone" : { "$ref" : "#/components/schemas/UsersMobile_phoneResourceAttribute", "exampleSetFlag" : false }, "last_logged_on" : { "$ref" : "#/components/schemas/UsersLast_logged_onResourceAttribute", "exampleSetFlag" : false }, "ms_admin" : { "$ref" : "#/components/schemas/UsersMs_adminResourceAttribute", "exampleSetFlag" : false }, "attachments_with_notifications" : { "$ref" : "#/components/schemas/UsersAttachments_with_notificationsResourceAttribute", "exampleSetFlag" : false }, "account_domains" : { "$ref" : "#/components/schemas/UsersAccount_domainsResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UsersEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "first_name" : { "$ref" : "#/components/schemas/UsersFirst_nameResourceAttribute", "exampleSetFlag" : false }, "show_managed_services" : { "$ref" : "#/components/schemas/UsersShow_managed_servicesResourceAttribute", "exampleSetFlag" : false }, "show_screenshots" : { "$ref" : "#/components/schemas/UsersShow_screenshotsResourceAttribute", "exampleSetFlag" : false }, "export_gps" : { "$ref" : "#/components/schemas/UsersExport_gpsResourceAttribute", "exampleSetFlag" : false }, "account_admin" : { "$ref" : "#/components/schemas/UsersAccount_adminResourceAttribute", "exampleSetFlag" : false }, "last_name" : { "$ref" : "#/components/schemas/UsersLast_nameResourceAttribute", "exampleSetFlag" : false }, "active" : { "$ref" : "#/components/schemas/UsersActiveResourceAttribute", "exampleSetFlag" : false }, "middle_name" : { "$ref" : "#/components/schemas/UsersMiddle_nameResourceAttribute", "exampleSetFlag" : false }, "cp_password" : { "$ref" : "#/components/schemas/UsersCp_passwordResourceAttribute", "exampleSetFlag" : false }, "display_name" : { "$ref" : "#/components/schemas/UsersDisplay_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UsersCreated_byResourceAttribute", "exampleSetFlag" : false }, "password_date" : { "$ref" : "#/components/schemas/UsersPassword_dateResourceAttribute", "exampleSetFlag" : false }, "nda_signed" : { "$ref" : "#/components/schemas/UsersNda_signedResourceAttribute", "exampleSetFlag" : false }, "show_damages" : { "$ref" : "#/components/schemas/UsersShow_damagesResourceAttribute", "exampleSetFlag" : false }, "email_address" : { "$ref" : "#/components/schemas/UsersEmail_addressResourceAttribute", "exampleSetFlag" : false }, "expiration_cycle" : { "$ref" : "#/components/schemas/UsersExpiration_cycleResourceAttribute", "exampleSetFlag" : false }, "show_tickets" : { "$ref" : "#/components/schemas/UsersShow_ticketsResourceAttribute", "exampleSetFlag" : false }, "show_gps" : { "$ref" : "#/components/schemas/UsersShow_gpsResourceAttribute", "exampleSetFlag" : false }, "preferred_name" : { "$ref" : "#/components/schemas/UsersPreferred_nameResourceAttribute", "exampleSetFlag" : false }, "show_history" : { "$ref" : "#/components/schemas/UsersShow_historyResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsersAllow_exportsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersExport_gpsResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersActiveResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UsersNda_signedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersExpiration_cycleResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsersPreferred_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersEmail_addressResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersAccount_adminResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersCustomerAccountsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "UsersLast_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsersCp_adminResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsersLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UsersLogo_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsicContactsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsicContactsAddress_line3ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsRd_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsGeneral_contactResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UsicContactsCpDistrictResourceAttribute" : { "$ref" : "#/components/schemas/CpDistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UsicContactsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsicContactsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsicContactsResourcePostAttributes", "exampleSetFlag" : false } ] }, "UsicContactsRd_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UsicContactsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UsicContactsIt_supportResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (usicContacts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "usicContacts" ] }, "id" : { "$ref" : "#/components/schemas/UsicContactsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsicContactsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsDistrict_stateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsAddress_line2ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsDm_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UsicContactsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/usicContacts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsIt_support_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsCountryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsGeneral_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsHrResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsSales_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UsicContactsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsAddress_line1ResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsEff_start_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UsicContactsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsicContactsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UsicContactsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsicContactsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsSales_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsHr_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsSales_contactResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsicContactsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsicContactsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsicContactsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsicContactsResourceLinks", "exampleSetFlag" : false } ] }, "UsicContactsDm_phone_noResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (usicContacts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "usicContacts" ] }, "id" : { "$ref" : "#/components/schemas/UsicContactsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "country" : { "$ref" : "#/components/schemas/UsicContactsCountryResourceAttribute", "exampleSetFlag" : false }, "district_state" : { "$ref" : "#/components/schemas/UsicContactsDistrict_stateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/UsicContactsCityResourceAttribute", "exampleSetFlag" : false }, "sales_contact" : { "$ref" : "#/components/schemas/UsicContactsSales_contactResourceAttribute", "exampleSetFlag" : false }, "hr" : { "$ref" : "#/components/schemas/UsicContactsHrResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UsicContactsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "sales_phone_no" : { "$ref" : "#/components/schemas/UsicContactsSales_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_email" : { "$ref" : "#/components/schemas/UsicContactsGeneral_emailResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UsicContactsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "address_line3" : { "$ref" : "#/components/schemas/UsicContactsAddress_line3ResourceAttribute", "exampleSetFlag" : false }, "address_line2" : { "$ref" : "#/components/schemas/UsicContactsAddress_line2ResourceAttribute", "exampleSetFlag" : false }, "address_line1" : { "$ref" : "#/components/schemas/UsicContactsAddress_line1ResourceAttribute", "exampleSetFlag" : false }, "it_support" : { "$ref" : "#/components/schemas/UsicContactsIt_supportResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UsicContactsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/UsicContactsStateResourceAttribute", "exampleSetFlag" : false }, "dm_phone_no" : { "$ref" : "#/components/schemas/UsicContactsDm_phone_noResourceAttribute", "exampleSetFlag" : false }, "it_support_phone_no" : { "$ref" : "#/components/schemas/UsicContactsIt_support_phone_noResourceAttribute", "exampleSetFlag" : false }, "dm_name" : { "$ref" : "#/components/schemas/UsicContactsDm_nameResourceAttribute", "exampleSetFlag" : false }, "rd_email" : { "$ref" : "#/components/schemas/UsicContactsRd_emailResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UsicContactsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "rd_name" : { "$ref" : "#/components/schemas/UsicContactsRd_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UsicContactsCreated_byResourceAttribute", "exampleSetFlag" : false }, "hr_phone_no" : { "$ref" : "#/components/schemas/UsicContactsHr_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_contact" : { "$ref" : "#/components/schemas/UsicContactsGeneral_contactResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UsicContactsCreated_onResourceAttribute", "exampleSetFlag" : false }, "sales_email" : { "$ref" : "#/components/schemas/UsicContactsSales_emailResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UsicContactsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "dm_email" : { "$ref" : "#/components/schemas/UsicContactsDm_emailResourceAttribute", "exampleSetFlag" : false }, "rd_phone_no" : { "$ref" : "#/components/schemas/UsicContactsRd_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_phone_no" : { "$ref" : "#/components/schemas/UsicContactsGeneral_phone_noResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "country" : { "$ref" : "#/components/schemas/UsicContactsCountryResourceAttribute", "exampleSetFlag" : false }, "district_state" : { "$ref" : "#/components/schemas/UsicContactsDistrict_stateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/UsicContactsCityResourceAttribute", "exampleSetFlag" : false }, "sales_contact" : { "$ref" : "#/components/schemas/UsicContactsSales_contactResourceAttribute", "exampleSetFlag" : false }, "hr" : { "$ref" : "#/components/schemas/UsicContactsHrResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UsicContactsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "sales_phone_no" : { "$ref" : "#/components/schemas/UsicContactsSales_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_email" : { "$ref" : "#/components/schemas/UsicContactsGeneral_emailResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UsicContactsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "address_line3" : { "$ref" : "#/components/schemas/UsicContactsAddress_line3ResourceAttribute", "exampleSetFlag" : false }, "address_line2" : { "$ref" : "#/components/schemas/UsicContactsAddress_line2ResourceAttribute", "exampleSetFlag" : false }, "address_line1" : { "$ref" : "#/components/schemas/UsicContactsAddress_line1ResourceAttribute", "exampleSetFlag" : false }, "it_support" : { "$ref" : "#/components/schemas/UsicContactsIt_supportResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/UsicContactsStateResourceAttribute", "exampleSetFlag" : false }, "dm_phone_no" : { "$ref" : "#/components/schemas/UsicContactsDm_phone_noResourceAttribute", "exampleSetFlag" : false }, "it_support_phone_no" : { "$ref" : "#/components/schemas/UsicContactsIt_support_phone_noResourceAttribute", "exampleSetFlag" : false }, "dm_name" : { "$ref" : "#/components/schemas/UsicContactsDm_nameResourceAttribute", "exampleSetFlag" : false }, "rd_email" : { "$ref" : "#/components/schemas/UsicContactsRd_emailResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UsicContactsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "rd_name" : { "$ref" : "#/components/schemas/UsicContactsRd_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UsicContactsCreated_byResourceAttribute", "exampleSetFlag" : false }, "hr_phone_no" : { "$ref" : "#/components/schemas/UsicContactsHr_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_contact" : { "$ref" : "#/components/schemas/UsicContactsGeneral_contactResourceAttribute", "exampleSetFlag" : false }, "sales_email" : { "$ref" : "#/components/schemas/UsicContactsSales_emailResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UsicContactsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "dm_email" : { "$ref" : "#/components/schemas/UsicContactsDm_emailResourceAttribute", "exampleSetFlag" : false }, "rd_phone_no" : { "$ref" : "#/components/schemas/UsicContactsRd_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_phone_no" : { "$ref" : "#/components/schemas/UsicContactsGeneral_phone_noResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsStateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsRd_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsCityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsDm_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "cpDistrict" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/usicContacts/{id}/relationships/cpDistrict" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/usicContacts/{id}/cpDistrict" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/CpDistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/CpDistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsEff_end_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UsicContactsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "country" : { "$ref" : "#/components/schemas/UsicContactsCountryResourceAttribute", "exampleSetFlag" : false }, "district_state" : { "$ref" : "#/components/schemas/UsicContactsDistrict_stateResourceAttribute", "exampleSetFlag" : false }, "city" : { "$ref" : "#/components/schemas/UsicContactsCityResourceAttribute", "exampleSetFlag" : false }, "sales_contact" : { "$ref" : "#/components/schemas/UsicContactsSales_contactResourceAttribute", "exampleSetFlag" : false }, "hr" : { "$ref" : "#/components/schemas/UsicContactsHrResourceAttribute", "exampleSetFlag" : false }, "eff_start_date" : { "$ref" : "#/components/schemas/UsicContactsEff_start_dateResourceAttribute", "exampleSetFlag" : false }, "sales_phone_no" : { "$ref" : "#/components/schemas/UsicContactsSales_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_email" : { "$ref" : "#/components/schemas/UsicContactsGeneral_emailResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UsicContactsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "address_line3" : { "$ref" : "#/components/schemas/UsicContactsAddress_line3ResourceAttribute", "exampleSetFlag" : false }, "address_line2" : { "$ref" : "#/components/schemas/UsicContactsAddress_line2ResourceAttribute", "exampleSetFlag" : false }, "address_line1" : { "$ref" : "#/components/schemas/UsicContactsAddress_line1ResourceAttribute", "exampleSetFlag" : false }, "it_support" : { "$ref" : "#/components/schemas/UsicContactsIt_supportResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UsicContactsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "state" : { "$ref" : "#/components/schemas/UsicContactsStateResourceAttribute", "exampleSetFlag" : false }, "dm_phone_no" : { "$ref" : "#/components/schemas/UsicContactsDm_phone_noResourceAttribute", "exampleSetFlag" : false }, "it_support_phone_no" : { "$ref" : "#/components/schemas/UsicContactsIt_support_phone_noResourceAttribute", "exampleSetFlag" : false }, "dm_name" : { "$ref" : "#/components/schemas/UsicContactsDm_nameResourceAttribute", "exampleSetFlag" : false }, "rd_email" : { "$ref" : "#/components/schemas/UsicContactsRd_emailResourceAttribute", "exampleSetFlag" : false }, "eff_end_date" : { "$ref" : "#/components/schemas/UsicContactsEff_end_dateResourceAttribute", "exampleSetFlag" : false }, "rd_name" : { "$ref" : "#/components/schemas/UsicContactsRd_nameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UsicContactsCreated_byResourceAttribute", "exampleSetFlag" : false }, "hr_phone_no" : { "$ref" : "#/components/schemas/UsicContactsHr_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_contact" : { "$ref" : "#/components/schemas/UsicContactsGeneral_contactResourceAttribute", "exampleSetFlag" : false }, "sales_email" : { "$ref" : "#/components/schemas/UsicContactsSales_emailResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UsicContactsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "dm_email" : { "$ref" : "#/components/schemas/UsicContactsDm_emailResourceAttribute", "exampleSetFlag" : false }, "rd_phone_no" : { "$ref" : "#/components/schemas/UsicContactsRd_phone_noResourceAttribute", "exampleSetFlag" : false }, "general_phone_no" : { "$ref" : "#/components/schemas/UsicContactsGeneral_phone_noResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsicContactsGeneral_emailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsicContactsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrRolesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrRolesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrRolesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/UsrRolesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UsrRolesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/UsrRolesNameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UsrRolesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/UsrRolesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrRolesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrRolesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UsrRolesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrRolesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/UsrRolesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UsrRolesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UsrRolesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/UsrRolesNameResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UsrRolesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UsrRolesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/UsrRolesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UsrRolesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UsrRolesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/usrRoles/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsrRolesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsrRolesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsrRolesResourceLinks", "exampleSetFlag" : false } ] }, "UsrRolesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (usrRoles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "usrRoles" ] }, "id" : { "$ref" : "#/components/schemas/UsrRolesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/UsrRolesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/UsrRolesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/UsrRolesNameResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UsrRolesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/UsrRolesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UsrRolesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrRolesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UsrRolesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsrRolesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsrRolesResourcePostAttributes", "exampleSetFlag" : false } ] }, "UsrRolesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UsrRolesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UsrRolesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsrRolesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsrRolesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (usrRoles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "usrRoles" ] }, "id" : { "$ref" : "#/components/schemas/UsrRolesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrRolesEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "UsrRolesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrRolesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UsrsCallout_formatResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsFailed_loginsResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsDistrict_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsDisplaynameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsReportingnodeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsrsLast_sync_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsReportsToResourceAttribute" : { "$ref" : "#/components/schemas/UsrsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UsrsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsPassword_expiresResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsReports_to_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsBilling_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsTkpDistrictResourceAttribute" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UsrsHome_phoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsOrg_super_region_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsTitleResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsrsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsrsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UsrsResourceLinks", "exampleSetFlag" : false } ] }, "UsrsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "password_lockout" : { "$ref" : "#/components/schemas/UsrsPassword_lockoutResourceAttribute", "exampleSetFlag" : false }, "firstname" : { "$ref" : "#/components/schemas/UsrsFirstnameResourceAttribute", "exampleSetFlag" : false }, "last_six_ssn" : { "$ref" : "#/components/schemas/UsrsLast_six_ssnResourceAttribute", "exampleSetFlag" : false }, "at_risk" : { "$ref" : "#/components/schemas/UsrsAt_riskResourceAttribute", "exampleSetFlag" : false }, "org_super_region_id" : { "$ref" : "#/components/schemas/UsrsOrg_super_region_idResourceAttribute", "exampleSetFlag" : false }, "password_crypt" : { "$ref" : "#/components/schemas/UsrsPassword_cryptResourceAttribute", "exampleSetFlag" : false }, "title" : { "$ref" : "#/components/schemas/UsrsTitleResourceAttribute", "exampleSetFlag" : false }, "work_area" : { "$ref" : "#/components/schemas/UsrsWork_areaResourceAttribute", "exampleSetFlag" : false }, "type" : { "$ref" : "#/components/schemas/UsrsTypeResourceAttribute", "exampleSetFlag" : false }, "department_number" : { "$ref" : "#/components/schemas/UsrsDepartment_numberResourceAttribute", "exampleSetFlag" : false }, "hr_manager" : { "$ref" : "#/components/schemas/UsrsHr_managerResourceAttribute", "exampleSetFlag" : false }, "continous_service_date" : { "$ref" : "#/components/schemas/UsrsContinous_service_dateResourceAttribute", "exampleSetFlag" : false }, "recent_hire_date" : { "$ref" : "#/components/schemas/UsrsRecent_hire_dateResourceAttribute", "exampleSetFlag" : false }, "supervisor_group_id" : { "$ref" : "#/components/schemas/UsrsSupervisor_group_idResourceAttribute", "exampleSetFlag" : false }, "storage_id" : { "$ref" : "#/components/schemas/UsrsStorage_idResourceAttribute", "exampleSetFlag" : false }, "workday_region" : { "$ref" : "#/components/schemas/UsrsWorkday_regionResourceAttribute", "exampleSetFlag" : false }, "prin_type" : { "$ref" : "#/components/schemas/UsrsPrin_typeResourceAttribute", "exampleSetFlag" : false }, "workday_super_region" : { "$ref" : "#/components/schemas/UsrsWorkday_super_regionResourceAttribute", "exampleSetFlag" : false }, "certified" : { "$ref" : "#/components/schemas/UsrsCertifiedResourceAttribute", "exampleSetFlag" : false }, "district_number" : { "$ref" : "#/components/schemas/UsrsDistrict_numberResourceAttribute", "exampleSetFlag" : false }, "timesheet_start_date" : { "$ref" : "#/components/schemas/UsrsTimesheet_start_dateResourceAttribute", "exampleSetFlag" : false }, "email" : { "$ref" : "#/components/schemas/UsrsEmailResourceAttribute", "exampleSetFlag" : false }, "workday_district_code" : { "$ref" : "#/components/schemas/UsrsWorkday_district_codeResourceAttribute", "exampleSetFlag" : false }, "timesheet_end_date" : { "$ref" : "#/components/schemas/UsrsTimesheet_end_dateResourceAttribute", "exampleSetFlag" : false }, "login_for_customer_id" : { "$ref" : "#/components/schemas/UsrsLogin_for_customer_idResourceAttribute", "exampleSetFlag" : false }, "home_phone" : { "$ref" : "#/components/schemas/UsrsHome_phoneResourceAttribute", "exampleSetFlag" : false }, "user_status" : { "$ref" : "#/components/schemas/UsrsUser_statusResourceAttribute", "exampleSetFlag" : false }, "loginname" : { "$ref" : "#/components/schemas/UsrsLoginnameResourceAttribute", "exampleSetFlag" : false }, "effective_supervisor_group_id" : { "$ref" : "#/components/schemas/UsrsEffective_supervisor_group_idResourceAttribute", "exampleSetFlag" : false }, "billing_id" : { "$ref" : "#/components/schemas/UsrsBilling_idResourceAttribute", "exampleSetFlag" : false }, "failed_logins" : { "$ref" : "#/components/schemas/UsrsFailed_loginsResourceAttribute", "exampleSetFlag" : false }, "default_project_id" : { "$ref" : "#/components/schemas/UsrsDefault_project_idResourceAttribute", "exampleSetFlag" : false }, "callout_format" : { "$ref" : "#/components/schemas/UsrsCallout_formatResourceAttribute", "exampleSetFlag" : false }, "reportingnode" : { "$ref" : "#/components/schemas/UsrsReportingnodeResourceAttribute", "exampleSetFlag" : false }, "reports_to_id" : { "$ref" : "#/components/schemas/UsrsReports_to_idResourceAttribute", "exampleSetFlag" : false }, "effective_district_id" : { "$ref" : "#/components/schemas/UsrsEffective_district_idResourceAttribute", "exampleSetFlag" : false }, "truck_number" : { "$ref" : "#/components/schemas/UsrsTruck_numberResourceAttribute", "exampleSetFlag" : false }, "communication_preference" : { "$ref" : "#/components/schemas/UsrsCommunication_preferenceResourceAttribute", "exampleSetFlag" : false }, "lastname" : { "$ref" : "#/components/schemas/UsrsLastnameResourceAttribute", "exampleSetFlag" : false }, "last_sync_date" : { "$ref" : "#/components/schemas/UsrsLast_sync_dateResourceAttribute", "exampleSetFlag" : false }, "activeuser" : { "$ref" : "#/components/schemas/UsrsActiveuserResourceAttribute", "exampleSetFlag" : false }, "peoplesoft_id" : { "$ref" : "#/components/schemas/UsrsPeoplesoft_idResourceAttribute", "exampleSetFlag" : false }, "password_expires" : { "$ref" : "#/components/schemas/UsrsPassword_expiresResourceAttribute", "exampleSetFlag" : false }, "phone" : { "$ref" : "#/components/schemas/UsrsPhoneResourceAttribute", "exampleSetFlag" : false }, "org_region_id" : { "$ref" : "#/components/schemas/UsrsOrg_region_idResourceAttribute", "exampleSetFlag" : false }, "displayname" : { "$ref" : "#/components/schemas/UsrsDisplaynameResourceAttribute", "exampleSetFlag" : false }, "employee_number" : { "$ref" : "#/components/schemas/UsrsEmployee_numberResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/UsrsDistrict_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsLastnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsWorkday_district_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsDefault_project_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsPassword_lockoutResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsCommunication_preferenceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsrsPostResourceReference", "exampleSetFlag" : false } ] }, "UsrsPrin_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsAt_riskResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsrsPassword_cryptResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsLogin_for_customer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsWorkday_super_regionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UsrsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UsrsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (usrs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "usrs" ] }, "id" : { "$ref" : "#/components/schemas/UsrsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsWork_areaResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsPhoneResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/usrs/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsWorkday_regionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UsrsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsEmailResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsHr_managerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsLast_six_ssnResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "dueDateExtensions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/usrs/{id}/relationships/dueDateExtensions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/usrs/{id}/dueDateExtensions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "tkpDistrict" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/usrs/{id}/relationships/tkpDistrict" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/usrs/{id}/tkpDistrict" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "buckets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/usrs/{id}/relationships/buckets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/usrs/{id}/buckets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "reportsTo" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/usrs/{id}/relationships/reportsTo" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/usrs/{id}/reportsTo" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsPeoplesoft_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsRecent_hire_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UsrsEffective_district_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsEmployee_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsContinous_service_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsTypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (usrs)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "usrs" ] }, "id" : { "$ref" : "#/components/schemas/UsrsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsTimesheet_start_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UsrsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UsrsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UsrsDueDateExtensionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "UsrsCertifiedResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsrsTimesheet_end_dateResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsActiveuserResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UsrsBucketsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/BucketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "UsrsLoginnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsFirstnameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsUser_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsEffective_supervisor_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsSupervisor_group_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsOrg_region_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UsrsDepartment_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsTruck_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UsrsStorage_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesContract_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UtilitiesPostResourceReference", "exampleSetFlag" : false } ] }, "UtilitiesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UtilitiesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesApp_keyResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesRequire_rescheduleResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesHp_scoringResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesExclude_holdoffResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UtilitiesScreen_bucket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesContract_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (utilities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "utilities" ] }, "id" : { "$ref" : "#/components/schemas/UtilitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesExport_billingResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesProximity_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (utilities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "utilities" ] }, "id" : { "$ref" : "#/components/schemas/UtilitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UtilitiesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UtilitiesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UtilitiesResourceLinks", "exampleSetFlag" : false } ] }, "UtilitiesRequire_academy_certificateResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesTkpCustomerResourceAttribute" : { "$ref" : "#/components/schemas/TkpCustomersResourceReference", "nullable" : true, "exampleSetFlag" : false }, "UtilitiesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "tkpCustomer" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/utilities/{id}/relationships/tkpCustomer" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/utilities/{id}/tkpCustomer" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpCustomersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TkpCustomersResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesRequire_certificateResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesAuto_closeResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UtilitiesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UtilitiesHas_gis_dataResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesService_list_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesSignature_requirementResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesOffice_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesQc_bucket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesRequire_areaResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesFacility_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesAbbrevResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "require_area" : { "$ref" : "#/components/schemas/UtilitiesRequire_areaResourceAttribute", "exampleSetFlag" : false }, "screen_bucket_id" : { "$ref" : "#/components/schemas/UtilitiesScreen_bucket_idResourceAttribute", "exampleSetFlag" : false }, "office_id" : { "$ref" : "#/components/schemas/UtilitiesOffice_idResourceAttribute", "exampleSetFlag" : false }, "auto_close" : { "$ref" : "#/components/schemas/UtilitiesAuto_closeResourceAttribute", "exampleSetFlag" : false }, "contract_number" : { "$ref" : "#/components/schemas/UtilitiesContract_numberResourceAttribute", "exampleSetFlag" : false }, "exclude_holdoff" : { "$ref" : "#/components/schemas/UtilitiesExclude_holdoffResourceAttribute", "exampleSetFlag" : false }, "require_eta" : { "$ref" : "#/components/schemas/UtilitiesRequire_etaResourceAttribute", "exampleSetFlag" : false }, "facility_type" : { "$ref" : "#/components/schemas/UtilitiesFacility_typeResourceAttribute", "exampleSetFlag" : false }, "hp_scoring" : { "$ref" : "#/components/schemas/UtilitiesHp_scoringResourceAttribute", "exampleSetFlag" : false }, "require_academy_certificate" : { "$ref" : "#/components/schemas/UtilitiesRequire_academy_certificateResourceAttribute", "exampleSetFlag" : false }, "proximity_code" : { "$ref" : "#/components/schemas/UtilitiesProximity_codeResourceAttribute", "exampleSetFlag" : false }, "drawing_abbrev" : { "$ref" : "#/components/schemas/UtilitiesDrawing_abbrevResourceAttribute", "exampleSetFlag" : false }, "require_reschedule" : { "$ref" : "#/components/schemas/UtilitiesRequire_rescheduleResourceAttribute", "exampleSetFlag" : false }, "signature_requirement" : { "$ref" : "#/components/schemas/UtilitiesSignature_requirementResourceAttribute", "exampleSetFlag" : false }, "contract_name" : { "$ref" : "#/components/schemas/UtilitiesContract_nameResourceAttribute", "exampleSetFlag" : false }, "require_certificate" : { "$ref" : "#/components/schemas/UtilitiesRequire_certificateResourceAttribute", "exampleSetFlag" : false }, "app_key" : { "$ref" : "#/components/schemas/UtilitiesApp_keyResourceAttribute", "exampleSetFlag" : false }, "export_billing" : { "$ref" : "#/components/schemas/UtilitiesExport_billingResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/UtilitiesNameResourceAttribute", "exampleSetFlag" : false }, "has_gis_data" : { "$ref" : "#/components/schemas/UtilitiesHas_gis_dataResourceAttribute", "exampleSetFlag" : false }, "service_list_id" : { "$ref" : "#/components/schemas/UtilitiesService_list_idResourceAttribute", "exampleSetFlag" : false }, "abbrev" : { "$ref" : "#/components/schemas/UtilitiesAbbrevResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/UtilitiesCustomer_idResourceAttribute", "exampleSetFlag" : false }, "require_manual_time" : { "$ref" : "#/components/schemas/UtilitiesRequire_manual_timeResourceAttribute", "exampleSetFlag" : false }, "qc_bucket_id" : { "$ref" : "#/components/schemas/UtilitiesQc_bucket_idResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesRequire_manual_timeResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesRequire_etaResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilitiesDrawing_abbrevResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/utilities/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UtilitiesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (utilitiesProfiles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "utilitiesProfiles" ] }, "id" : { "$ref" : "#/components/schemas/UtilitiesProfilesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesFacility_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesProfilesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "utility_type" : { "$ref" : "#/components/schemas/UtilitiesProfilesUtility_typeResourceAttribute", "exampleSetFlag" : false }, "utility_type_id" : { "$ref" : "#/components/schemas/UtilitiesProfilesUtility_type_idResourceAttribute", "exampleSetFlag" : false }, "facility_id" : { "$ref" : "#/components/schemas/UtilitiesProfilesFacility_idResourceAttribute", "exampleSetFlag" : false }, "facility_type" : { "$ref" : "#/components/schemas/UtilitiesProfilesFacility_typeResourceAttribute", "exampleSetFlag" : false }, "facility_type_id" : { "$ref" : "#/components/schemas/UtilitiesProfilesFacility_type_idResourceAttribute", "exampleSetFlag" : false }, "facility" : { "$ref" : "#/components/schemas/UtilitiesProfilesFacilityResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/utilitiesProfiles/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UtilitiesProfilesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UtilitiesProfilesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UtilitiesProfilesResourceLinks", "exampleSetFlag" : false } ] }, "UtilitiesProfilesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UtilitiesProfilesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UtilitiesProfilesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesFacility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesProfilesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (utilitiesProfiles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "utilitiesProfiles" ] }, "id" : { "$ref" : "#/components/schemas/UtilitiesProfilesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesUtility_type_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilitiesProfilesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesProfilesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesFacility_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesProfilesFacilityResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesProfilesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UtilitiesProfilesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UtilitiesProfilesPostResourceReference", "exampleSetFlag" : false } ] }, "UtilitiesProfilesIdResourceAttribute" : { "type" : "object", "properties" : { "facility_type_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "utility_type_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] }, "facility_id" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilitiesProfilesUtility_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilitiesProfilesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UtilityandFacilitiesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/utilityandFacilities/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceLinks", "exampleSetFlag" : false } ] }, "UtilityandFacilitiesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UtilityandFacilitiesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilityandFacilitiesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/UtilityandFacilitiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "item_type" : { "$ref" : "#/components/schemas/UtilityandFacilitiesItem_typeResourceAttribute", "exampleSetFlag" : false }, "item_name" : { "$ref" : "#/components/schemas/UtilityandFacilitiesItem_nameResourceAttribute", "exampleSetFlag" : false }, "active_flag" : { "$ref" : "#/components/schemas/UtilityandFacilitiesActive_flagResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UtilityandFacilitiesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UtilityandFacilitiesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilityandFacilitiesItem_typeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "UtilityandFacilitiesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (utilityandFacilities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "utilityandFacilities" ] }, "id" : { "$ref" : "#/components/schemas/UtilityandFacilitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UtilityandFacilitiesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UtilityandFacilitiesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "UtilityandFacilitiesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/UtilityandFacilitiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "item_type" : { "$ref" : "#/components/schemas/UtilityandFacilitiesItem_typeResourceAttribute", "exampleSetFlag" : false }, "item_name" : { "$ref" : "#/components/schemas/UtilityandFacilitiesItem_nameResourceAttribute", "exampleSetFlag" : false }, "active_flag" : { "$ref" : "#/components/schemas/UtilityandFacilitiesActive_flagResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UtilityandFacilitiesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "UtilityandFacilitiesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (utilityandFacilities)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "utilityandFacilities" ] }, "id" : { "$ref" : "#/components/schemas/UtilityandFacilitiesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/UtilityandFacilitiesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/UtilityandFacilitiesCreated_onResourceAttribute", "exampleSetFlag" : false }, "item_type" : { "$ref" : "#/components/schemas/UtilityandFacilitiesItem_typeResourceAttribute", "exampleSetFlag" : false }, "item_name" : { "$ref" : "#/components/schemas/UtilityandFacilitiesItem_nameResourceAttribute", "exampleSetFlag" : false }, "active_flag" : { "$ref" : "#/components/schemas/UtilityandFacilitiesActive_flagResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/UtilityandFacilitiesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/UtilityandFacilitiesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "UtilityandFacilitiesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/UtilityandFacilitiesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/UtilityandFacilitiesResourcePostAttributes", "exampleSetFlag" : false } ] }, "UtilityandFacilitiesActive_flagResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "UtilityandFacilitiesItem_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "UtilityandFacilitiesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/UtilityandFacilitiesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "UtilityandFacilitiesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VehiclesModel_yearResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VehiclesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VehiclesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VehiclesEmployeesActiveMultipleItAssetsResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VehiclesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/vehicles/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "model_group" : { "$ref" : "#/components/schemas/VehiclesModel_groupResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/VehiclesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "book_value" : { "$ref" : "#/components/schemas/VehiclesBook_valueResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/VehiclesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "vin_number" : { "$ref" : "#/components/schemas/VehiclesVin_numberResourceAttribute", "exampleSetFlag" : false }, "model_year" : { "$ref" : "#/components/schemas/VehiclesModel_yearResourceAttribute", "exampleSetFlag" : false }, "cvn" : { "$ref" : "#/components/schemas/VehiclesCvnResourceAttribute", "exampleSetFlag" : false }, "make" : { "$ref" : "#/components/schemas/VehiclesMakeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/VehiclesCreated_byResourceAttribute", "exampleSetFlag" : false }, "license_plate_number" : { "$ref" : "#/components/schemas/VehiclesLicense_plate_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VehiclesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VehiclesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VehiclesResourcePostRelationships", "exampleSetFlag" : false } ] }, "VehiclesVin_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VehiclesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VehiclesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VehiclesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VehiclesResourceLinks", "exampleSetFlag" : false } ] }, "VehiclesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "model_group" : { "$ref" : "#/components/schemas/VehiclesModel_groupResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/VehiclesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "book_value" : { "$ref" : "#/components/schemas/VehiclesBook_valueResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/VehiclesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "vin_number" : { "$ref" : "#/components/schemas/VehiclesVin_numberResourceAttribute", "exampleSetFlag" : false }, "model_year" : { "$ref" : "#/components/schemas/VehiclesModel_yearResourceAttribute", "exampleSetFlag" : false }, "cvn" : { "$ref" : "#/components/schemas/VehiclesCvnResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VehiclesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "make" : { "$ref" : "#/components/schemas/VehiclesMakeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/VehiclesCreated_byResourceAttribute", "exampleSetFlag" : false }, "license_plate_number" : { "$ref" : "#/components/schemas/VehiclesLicense_plate_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesLicense_plate_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VehiclesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VehiclesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (vehicles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "vehicles" ] }, "id" : { "$ref" : "#/components/schemas/VehiclesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VehiclesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VehiclesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/VehiclesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "VehiclesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeesActiveNoAsset" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/vehicles/{id}/relationships/employeesActiveNoAsset" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/vehicles/{id}/employeesActiveNoAsset" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeeOnLoan" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/vehicles/{id}/relationships/employeeOnLoan" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/vehicles/{id}/employeeOnLoan" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employeesActiveMultipleItAssets" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/vehicles/{id}/relationships/employeesActiveMultipleItAssets" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/vehicles/{id}/employeesActiveMultipleItAssets" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/vehicles/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/vehicles/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "VehiclesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesModel_groupResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VehiclesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeeOnLoan" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VehiclesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (vehicles)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "vehicles" ] }, "id" : { "$ref" : "#/components/schemas/VehiclesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesCvnResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VehiclesEmployeesActiveNoAssetResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VehiclesIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "VehiclesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeeOnLoan" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesEmployeeOnLoanResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VehiclesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "VehiclesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VehiclesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "VehiclesEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VehiclesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "model_group" : { "$ref" : "#/components/schemas/VehiclesModel_groupResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/VehiclesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "book_value" : { "$ref" : "#/components/schemas/VehiclesBook_valueResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/VehiclesCreated_onResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/VehiclesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "vin_number" : { "$ref" : "#/components/schemas/VehiclesVin_numberResourceAttribute", "exampleSetFlag" : false }, "model_year" : { "$ref" : "#/components/schemas/VehiclesModel_yearResourceAttribute", "exampleSetFlag" : false }, "cvn" : { "$ref" : "#/components/schemas/VehiclesCvnResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VehiclesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "make" : { "$ref" : "#/components/schemas/VehiclesMakeResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/VehiclesCreated_byResourceAttribute", "exampleSetFlag" : false }, "license_plate_number" : { "$ref" : "#/components/schemas/VehiclesLicense_plate_numberResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VehiclesBook_valueResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "VehiclesMakeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesSuspn_deactv_dtResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoriesReason_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesIp_pool_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesCurrent_dvcidResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (verizonWirelessInventories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "verizonWirelessInventories" ] }, "id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesMdl_initResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesCustomer_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoriesCcntrct_end_dtResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoriesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesMinResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesEcpdResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoriesEsnResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesMtn_stat_eff_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoriesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesDevice_modelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesPplan_descResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceLinks", "exampleSetFlag" : false } ] }, "VerizonWirelessInventoriesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourcePostAttributes", "exampleSetFlag" : false } ] }, "VerizonWirelessInventoriesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "VerizonWirelessInventoriesDevice_makeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "auto_reconn_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesAuto_reconn_dateResourceAttribute", "exampleSetFlag" : false }, "esn" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesEsnResourceAttribute", "exampleSetFlag" : false }, "mtn_stat_eff_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesMtn_stat_eff_dateResourceAttribute", "exampleSetFlag" : false }, "listSfos" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesListSfosResourceAttribute", "exampleSetFlag" : false }, "device_model" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesDevice_modelResourceAttribute", "exampleSetFlag" : false }, "cust_mtn_stat" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCust_mtn_statResourceAttribute", "exampleSetFlag" : false }, "activation_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesActivation_dateResourceAttribute", "exampleSetFlag" : false }, "bsns_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesBsns_idResourceAttribute", "exampleSetFlag" : false }, "sfo_code_cnt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesSfo_code_cntResourceAttribute", "exampleSetFlag" : false }, "family_nme" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesFamily_nmeResourceAttribute", "exampleSetFlag" : false }, "reason_code" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesReason_codeResourceAttribute", "exampleSetFlag" : false }, "iccid" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIccidResourceAttribute", "exampleSetFlag" : false }, "pplan_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPplan_idResourceAttribute", "exampleSetFlag" : false }, "given_nme" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesGiven_nmeResourceAttribute", "exampleSetFlag" : false }, "min" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesMinResourceAttribute", "exampleSetFlag" : false }, "bill_acc_num" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesBill_acc_numResourceAttribute", "exampleSetFlag" : false }, "bill_cycle_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesBill_cycle_idResourceAttribute", "exampleSetFlag" : false }, "ccntrct_end_dt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCcntrct_end_dtResourceAttribute", "exampleSetFlag" : false }, "pplan_cost" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPplan_costResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "pplan_desc" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPplan_descResourceAttribute", "exampleSetFlag" : false }, "upgrade_elig_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesUpgrade_elig_dateResourceAttribute", "exampleSetFlag" : false }, "mdl_init" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesMdl_initResourceAttribute", "exampleSetFlag" : false }, "last_upgrade_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesLast_upgrade_dateResourceAttribute", "exampleSetFlag" : false }, "suspn_deactv_dt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesSuspn_deactv_dtResourceAttribute", "exampleSetFlag" : false }, "ip" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIpResourceAttribute", "exampleSetFlag" : false }, "ccntrct_start_dt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCcntrct_start_dtResourceAttribute", "exampleSetFlag" : false }, "device_make" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesDevice_makeResourceAttribute", "exampleSetFlag" : false }, "cost_center" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCost_centerResourceAttribute", "exampleSetFlag" : false }, "current_dvcid" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCurrent_dvcidResourceAttribute", "exampleSetFlag" : false }, "ip_pool_name" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIp_pool_nameResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCustomer_idResourceAttribute", "exampleSetFlag" : false }, "ecpd" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesEcpdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "VerizonWirelessInventoriesLast_upgrade_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoriesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "auto_reconn_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesAuto_reconn_dateResourceAttribute", "exampleSetFlag" : false }, "esn" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesEsnResourceAttribute", "exampleSetFlag" : false }, "mtn_stat_eff_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesMtn_stat_eff_dateResourceAttribute", "exampleSetFlag" : false }, "listSfos" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesListSfosResourceAttribute", "exampleSetFlag" : false }, "device_model" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesDevice_modelResourceAttribute", "exampleSetFlag" : false }, "cust_mtn_stat" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCust_mtn_statResourceAttribute", "exampleSetFlag" : false }, "activation_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesActivation_dateResourceAttribute", "exampleSetFlag" : false }, "bsns_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesBsns_idResourceAttribute", "exampleSetFlag" : false }, "sfo_code_cnt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesSfo_code_cntResourceAttribute", "exampleSetFlag" : false }, "family_nme" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesFamily_nmeResourceAttribute", "exampleSetFlag" : false }, "reason_code" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesReason_codeResourceAttribute", "exampleSetFlag" : false }, "iccid" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIccidResourceAttribute", "exampleSetFlag" : false }, "pplan_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPplan_idResourceAttribute", "exampleSetFlag" : false }, "given_nme" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesGiven_nmeResourceAttribute", "exampleSetFlag" : false }, "min" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesMinResourceAttribute", "exampleSetFlag" : false }, "bill_acc_num" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesBill_acc_numResourceAttribute", "exampleSetFlag" : false }, "bill_cycle_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesBill_cycle_idResourceAttribute", "exampleSetFlag" : false }, "ccntrct_end_dt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCcntrct_end_dtResourceAttribute", "exampleSetFlag" : false }, "pplan_cost" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPplan_costResourceAttribute", "exampleSetFlag" : false }, "pplan_desc" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPplan_descResourceAttribute", "exampleSetFlag" : false }, "upgrade_elig_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesUpgrade_elig_dateResourceAttribute", "exampleSetFlag" : false }, "mdl_init" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesMdl_initResourceAttribute", "exampleSetFlag" : false }, "last_upgrade_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesLast_upgrade_dateResourceAttribute", "exampleSetFlag" : false }, "suspn_deactv_dt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesSuspn_deactv_dtResourceAttribute", "exampleSetFlag" : false }, "ip" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIpResourceAttribute", "exampleSetFlag" : false }, "ccntrct_start_dt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCcntrct_start_dtResourceAttribute", "exampleSetFlag" : false }, "device_make" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesDevice_makeResourceAttribute", "exampleSetFlag" : false }, "cost_center" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCost_centerResourceAttribute", "exampleSetFlag" : false }, "current_dvcid" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCurrent_dvcidResourceAttribute", "exampleSetFlag" : false }, "ip_pool_name" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIp_pool_nameResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCustomer_idResourceAttribute", "exampleSetFlag" : false }, "ecpd" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesEcpdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesIccidResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesUpgrade_elig_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoriesCust_mtn_statResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesCcntrct_start_dtResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoriesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "verizonWirelessInventorySfos" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventories/{id}/relationships/verizonWirelessInventorySfos" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventories/{id}/verizonWirelessInventorySfos" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesIpResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesCost_centerResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoriesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventories/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesPplan_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoriesGiven_nmeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesListSfosResourceAttribute" : { "uniqueItems" : false, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "VerizonWirelessInventoriesVerizonWirelessInventorySfosResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "VerizonWirelessInventoriesPplan_costResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "VerizonWirelessInventoriesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "auto_reconn_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesAuto_reconn_dateResourceAttribute", "exampleSetFlag" : false }, "esn" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesEsnResourceAttribute", "exampleSetFlag" : false }, "mtn_stat_eff_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesMtn_stat_eff_dateResourceAttribute", "exampleSetFlag" : false }, "listSfos" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesListSfosResourceAttribute", "exampleSetFlag" : false }, "device_model" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesDevice_modelResourceAttribute", "exampleSetFlag" : false }, "cust_mtn_stat" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCust_mtn_statResourceAttribute", "exampleSetFlag" : false }, "activation_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesActivation_dateResourceAttribute", "exampleSetFlag" : false }, "bsns_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesBsns_idResourceAttribute", "exampleSetFlag" : false }, "sfo_code_cnt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesSfo_code_cntResourceAttribute", "exampleSetFlag" : false }, "family_nme" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesFamily_nmeResourceAttribute", "exampleSetFlag" : false }, "reason_code" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesReason_codeResourceAttribute", "exampleSetFlag" : false }, "iccid" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIccidResourceAttribute", "exampleSetFlag" : false }, "pplan_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPplan_idResourceAttribute", "exampleSetFlag" : false }, "given_nme" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesGiven_nmeResourceAttribute", "exampleSetFlag" : false }, "min" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesMinResourceAttribute", "exampleSetFlag" : false }, "bill_acc_num" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesBill_acc_numResourceAttribute", "exampleSetFlag" : false }, "bill_cycle_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesBill_cycle_idResourceAttribute", "exampleSetFlag" : false }, "ccntrct_end_dt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCcntrct_end_dtResourceAttribute", "exampleSetFlag" : false }, "pplan_cost" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPplan_costResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "pplan_desc" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPplan_descResourceAttribute", "exampleSetFlag" : false }, "upgrade_elig_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesUpgrade_elig_dateResourceAttribute", "exampleSetFlag" : false }, "mdl_init" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesMdl_initResourceAttribute", "exampleSetFlag" : false }, "last_upgrade_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesLast_upgrade_dateResourceAttribute", "exampleSetFlag" : false }, "suspn_deactv_dt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesSuspn_deactv_dtResourceAttribute", "exampleSetFlag" : false }, "ip" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIpResourceAttribute", "exampleSetFlag" : false }, "ccntrct_start_dt" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCcntrct_start_dtResourceAttribute", "exampleSetFlag" : false }, "device_make" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesDevice_makeResourceAttribute", "exampleSetFlag" : false }, "cost_center" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCost_centerResourceAttribute", "exampleSetFlag" : false }, "current_dvcid" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCurrent_dvcidResourceAttribute", "exampleSetFlag" : false }, "ip_pool_name" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIp_pool_nameResourceAttribute", "exampleSetFlag" : false }, "customer_id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesCustomer_idResourceAttribute", "exampleSetFlag" : false }, "ecpd" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesEcpdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "VerizonWirelessInventoriesBill_cycle_idResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoriesSfo_code_cntResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoriesAuto_reconn_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoriesBill_acc_numResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoriesActivation_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoriesFamily_nmeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesBsns_idResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoriesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoriesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (verizonWirelessInventories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "verizonWirelessInventories" ] }, "id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosSfo_codeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventorySfosResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "mdn" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosMdnResourceAttribute", "exampleSetFlag" : false }, "sfo_code" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosSfo_codeResourceAttribute", "exampleSetFlag" : false }, "sfo_description" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosSfo_descriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosLast_updated_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventorySfos/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "verizonWirelessInventory" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventorySfos/{id}/relationships/verizonWirelessInventory" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventorySfos/{id}/verizonWirelessInventory" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "VerizonWirelessInventorySfosResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "sfo_description" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosSfo_descriptionResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "VerizonWirelessInventorySfosResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "verizonWirelessInventory" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "VerizonWirelessInventorySfosResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "verizonWirelessInventory" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosVerizonWirelessInventoryResourceAttribute" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventorySfosSfo_descriptionResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventorySfosResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (verizonWirelessInventorySfos)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "verizonWirelessInventorySfos" ] }, "id" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosIdResourceAttribute" : { "type" : "object", "properties" : { "mdn" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "sfo_code" : { "type" : "integer", "format" : "int32", "exampleSetFlag" : false, "types" : [ "integer" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "sfo_description" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosSfo_descriptionResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosLast_updated_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosMdnResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventorySfosPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (verizonWirelessInventorySfos)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "verizonWirelessInventorySfos" ] }, "id" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventorySfosPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourcePostRelationships", "exampleSetFlag" : false } ] }, "VerizonWirelessInventorySfosResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceLinks", "exampleSetFlag" : false } ] }, "VerizonWirelessInventoryUsageSummariesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "usage_sms" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_smsResourceAttribute", "exampleSetFlag" : false }, "usage_bytes" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_bytesResourceAttribute", "exampleSetFlag" : false }, "acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesAcct_noResourceAttribute", "exampleSetFlag" : false }, "sub_acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesSub_acct_noResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "usage_minutes" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_minutesResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "verizonWirelessInventoryUsages" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventoryUsageSummaries/{id}/relationships/verizonWirelessInventoryUsages" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventoryUsageSummaries/{id}/verizonWirelessInventoryUsages" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesIdResourceAttribute" : { "type" : "object", "properties" : { "mdn" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "usage_date" : { "type" : "string", "format" : "date", "exampleSetFlag" : false, "types" : [ "string" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesUsage_smsResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsageSummariesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourcePostAttributes", "exampleSetFlag" : false } ] }, "VerizonWirelessInventoryUsageSummariesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceLinks", "exampleSetFlag" : false } ] }, "VerizonWirelessInventoryUsageSummariesMdnResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsageSummariesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "usage_sms" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_smsResourceAttribute", "exampleSetFlag" : false }, "usage_bytes" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_bytesResourceAttribute", "exampleSetFlag" : false }, "acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesAcct_noResourceAttribute", "exampleSetFlag" : false }, "sub_acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesSub_acct_noResourceAttribute", "exampleSetFlag" : false }, "usage_minutes" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_minutesResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "usage_sms" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_smsResourceAttribute", "exampleSetFlag" : false }, "mdn" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesMdnResourceAttribute", "exampleSetFlag" : false }, "usage_bytes" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_bytesResourceAttribute", "exampleSetFlag" : false }, "acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesAcct_noResourceAttribute", "exampleSetFlag" : false }, "usage_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_dateResourceAttribute", "exampleSetFlag" : false }, "sub_acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesSub_acct_noResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "usage_minutes" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesUsage_minutesResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesUsage_bytesResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsageSummariesVerizonWirelessInventoryUsagesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "VerizonWirelessInventoryUsageSummariesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "VerizonWirelessInventoryUsageSummariesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "VerizonWirelessInventoryUsageSummariesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "VerizonWirelessInventoryUsageSummariesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (verizonWirelessInventoryUsageSummaries)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "verizonWirelessInventoryUsageSummaries" ] }, "id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesUsage_minutesResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsageSummariesSub_acct_noResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsageSummariesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (verizonWirelessInventoryUsageSummaries)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "verizonWirelessInventoryUsageSummaries" ] }, "id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventoryUsageSummaries/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsageSummariesAcct_noResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsageSummariesUsage_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesRoaming_providerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesSequence_numResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsagesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (verizonWirelessInventoryUsages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "verizonWirelessInventoryUsages" ] }, "id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesIncoming_direction_indResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventoryUsages/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesFillerResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesUsage_timeResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoryUsagesDialed_digitsResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "verizonWirelessInventoryUsageSummary" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventoryUsages/{id}/relationships/verizonWirelessInventoryUsageSummary" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/verizonWirelessInventoryUsages/{id}/verizonWirelessInventoryUsageSummary" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "VerizonWirelessInventoryUsagesDuration_timeResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsagesUsage_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesVerizonWirelessInventoryUsageSummaryResourceAttribute" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VerizonWirelessInventoryUsagesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "roaming_ind" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesRoaming_indResourceAttribute", "exampleSetFlag" : false }, "sequence_num" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesSequence_numResourceAttribute", "exampleSetFlag" : false }, "incoming_direction_ind" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesIncoming_direction_indResourceAttribute", "exampleSetFlag" : false }, "dialed_digits" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesDialed_digitsResourceAttribute", "exampleSetFlag" : false }, "sub_acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesSub_acct_noResourceAttribute", "exampleSetFlag" : false }, "overseas_ind" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesOverseas_indResourceAttribute", "exampleSetFlag" : false }, "country_code" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesCountry_codeResourceAttribute", "exampleSetFlag" : false }, "usage_count" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesUsage_countResourceAttribute", "exampleSetFlag" : false }, "usage_type" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesUsage_typeResourceAttribute", "exampleSetFlag" : false }, "roaming_provider" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesRoaming_providerResourceAttribute", "exampleSetFlag" : false }, "acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesAcct_noResourceAttribute", "exampleSetFlag" : false }, "data_type" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesData_typeResourceAttribute", "exampleSetFlag" : false }, "filler" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesFillerResourceAttribute", "exampleSetFlag" : false }, "duration_time" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesDuration_timeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesAcct_noResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsagesIdResourceAttribute" : { "type" : "object", "properties" : { "mdn" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "usage_date" : { "type" : "string", "format" : "date", "exampleSetFlag" : false, "types" : [ "string" ] }, "usage_time" : { "type" : "time", "exampleSetFlag" : false } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceLinks", "exampleSetFlag" : false } ] }, "VerizonWirelessInventoryUsagesMdnResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesUsage_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "VerizonWirelessInventoryUsagesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (verizonWirelessInventoryUsages)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "verizonWirelessInventoryUsages" ] }, "id" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "verizonWirelessInventoryUsageSummary" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesUsage_countResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsagesCountry_codeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesRoaming_indResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourcePostRelationships", "exampleSetFlag" : false } ] }, "VerizonWirelessInventoryUsagesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "roaming_ind" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesRoaming_indResourceAttribute", "exampleSetFlag" : false }, "sequence_num" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesSequence_numResourceAttribute", "exampleSetFlag" : false }, "incoming_direction_ind" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesIncoming_direction_indResourceAttribute", "exampleSetFlag" : false }, "dialed_digits" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesDialed_digitsResourceAttribute", "exampleSetFlag" : false }, "sub_acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesSub_acct_noResourceAttribute", "exampleSetFlag" : false }, "overseas_ind" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesOverseas_indResourceAttribute", "exampleSetFlag" : false }, "country_code" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesCountry_codeResourceAttribute", "exampleSetFlag" : false }, "usage_count" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesUsage_countResourceAttribute", "exampleSetFlag" : false }, "usage_type" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesUsage_typeResourceAttribute", "exampleSetFlag" : false }, "roaming_provider" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesRoaming_providerResourceAttribute", "exampleSetFlag" : false }, "acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesAcct_noResourceAttribute", "exampleSetFlag" : false }, "data_type" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesData_typeResourceAttribute", "exampleSetFlag" : false }, "filler" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesFillerResourceAttribute", "exampleSetFlag" : false }, "duration_time" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesDuration_timeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesLast_updated_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesData_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesSub_acct_noResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VerizonWirelessInventoryUsagesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "verizonWirelessInventoryUsageSummary" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesOverseas_indResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VerizonWirelessInventoryUsagesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "roaming_ind" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesRoaming_indResourceAttribute", "exampleSetFlag" : false }, "sequence_num" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesSequence_numResourceAttribute", "exampleSetFlag" : false }, "incoming_direction_ind" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesIncoming_direction_indResourceAttribute", "exampleSetFlag" : false }, "dialed_digits" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesDialed_digitsResourceAttribute", "exampleSetFlag" : false }, "usage_time" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesUsage_timeResourceAttribute", "exampleSetFlag" : false }, "usage_date" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesUsage_dateResourceAttribute", "exampleSetFlag" : false }, "sub_acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesSub_acct_noResourceAttribute", "exampleSetFlag" : false }, "overseas_ind" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesOverseas_indResourceAttribute", "exampleSetFlag" : false }, "country_code" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesCountry_codeResourceAttribute", "exampleSetFlag" : false }, "usage_count" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesUsage_countResourceAttribute", "exampleSetFlag" : false }, "usage_type" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesUsage_typeResourceAttribute", "exampleSetFlag" : false }, "roaming_provider" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesRoaming_providerResourceAttribute", "exampleSetFlag" : false }, "mdn" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesMdnResourceAttribute", "exampleSetFlag" : false }, "acct_no" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesAcct_noResourceAttribute", "exampleSetFlag" : false }, "data_type" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesData_typeResourceAttribute", "exampleSetFlag" : false }, "filler" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesFillerResourceAttribute", "exampleSetFlag" : false }, "duration_time" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesDuration_timeResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesLast_updated_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VerizonWirelessInventoryUsagesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ViolationStatusesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ViolationStatusesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ViolationStatusesNameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ViolationStatusesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (violationStatuses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "violationStatuses" ] }, "id" : { "$ref" : "#/components/schemas/ViolationStatusesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ViolationStatusesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ViolationStatusesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/violationStatuses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ViolationStatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ViolationStatusesNameResourceAttribute", "exampleSetFlag" : false }, "display_order" : { "$ref" : "#/components/schemas/ViolationStatusesDisplay_orderResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ViolationStatusesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "category" : { "$ref" : "#/components/schemas/ViolationStatusesCategoryResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ViolationStatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ViolationStatusesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ViolationStatusesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ViolationStatusesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "ViolationStatusesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ViolationStatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/ViolationStatusesCreated_onResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ViolationStatusesNameResourceAttribute", "exampleSetFlag" : false }, "display_order" : { "$ref" : "#/components/schemas/ViolationStatusesDisplay_orderResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/ViolationStatusesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "category" : { "$ref" : "#/components/schemas/ViolationStatusesCategoryResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ViolationStatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesCategoryResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ViolationStatusesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "ViolationStatusesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/ViolationStatusesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "name" : { "$ref" : "#/components/schemas/ViolationStatusesNameResourceAttribute", "exampleSetFlag" : false }, "display_order" : { "$ref" : "#/components/schemas/ViolationStatusesDisplay_orderResourceAttribute", "exampleSetFlag" : false }, "category" : { "$ref" : "#/components/schemas/ViolationStatusesCategoryResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/ViolationStatusesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ViolationStatusesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ViolationStatusesResourcePostAttributes", "exampleSetFlag" : false } ] }, "ViolationStatusesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/ViolationStatusesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ViolationStatusesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/ViolationStatusesResourceLinks", "exampleSetFlag" : false } ] }, "ViolationStatusesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ViolationStatusesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (violationStatuses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "violationStatuses" ] }, "id" : { "$ref" : "#/components/schemas/ViolationStatusesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/ViolationStatusesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "ViolationStatusesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/ViolationStatusesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ViolationStatusesDisplay_orderResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "ViolationStatusesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "ViolationStatusesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ViolationStatusesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsLongitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "VisitLocationsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VisitLocationsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VisitLocationsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visitLocations/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VisitLocationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VisitLocationsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VisitLocationsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VisitLocationsResourceLinks", "exampleSetFlag" : false } ] }, "VisitLocationsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VisitLocationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (visitLocations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "visitLocations" ] }, "id" : { "$ref" : "#/components/schemas/VisitLocationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "distance" : { "$ref" : "#/components/schemas/VisitLocationsDistanceResourceAttribute", "exampleSetFlag" : false }, "latitude" : { "$ref" : "#/components/schemas/VisitLocationsLatitudeResourceAttribute", "exampleSetFlag" : false }, "source" : { "$ref" : "#/components/schemas/VisitLocationsSourceResourceAttribute", "exampleSetFlag" : false }, "on_site" : { "$ref" : "#/components/schemas/VisitLocationsOn_siteResourceAttribute", "exampleSetFlag" : false }, "longitude" : { "$ref" : "#/components/schemas/VisitLocationsLongitudeResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsLatitudeResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "VisitLocationsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "visit" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visitLocations/{id}/relationships/visit" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visitLocations/{id}/visit" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsDistanceResourceAttribute" : { "type" : "number", "format" : "double", "nullable" : true, "exampleSetFlag" : false, "types" : [ "number" ] }, "VisitLocationsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VisitLocationsPostResourceReference", "exampleSetFlag" : false } ] }, "VisitLocationsOn_siteResourceAttribute" : { "type" : "boolean", "nullable" : true, "exampleSetFlag" : false, "types" : [ "boolean" ] }, "VisitLocationsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VisitLocationsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitLocationsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsVisitResourceAttribute" : { "$ref" : "#/components/schemas/VisitsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VisitLocationsSourceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VisitLocationsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitLocationsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "VisitLocationsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (visitLocations)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "visitLocations" ] }, "id" : { "$ref" : "#/components/schemas/VisitLocationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitLocationsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/VisitLocationsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "VisitsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "VisitsTicket_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VisitsTkpDistrictResourceAttribute" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VisitsOpenedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VisitsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (visits)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "visits" ] }, "id" : { "$ref" : "#/components/schemas/VisitsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VisitsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "when_saved_local" : { "$ref" : "#/components/schemas/VisitsWhen_saved_localResourceAttribute", "exampleSetFlag" : false }, "arrived" : { "$ref" : "#/components/schemas/VisitsArrivedResourceAttribute", "exampleSetFlag" : false }, "departed" : { "$ref" : "#/components/schemas/VisitsDepartedResourceAttribute", "exampleSetFlag" : false }, "synced_up" : { "$ref" : "#/components/schemas/VisitsSynced_upResourceAttribute", "exampleSetFlag" : false }, "opened" : { "$ref" : "#/components/schemas/VisitsOpenedResourceAttribute", "exampleSetFlag" : false }, "actor_id" : { "$ref" : "#/components/schemas/VisitsActor_idResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/VisitsDistrict_idResourceAttribute", "exampleSetFlag" : false }, "ticket_id" : { "$ref" : "#/components/schemas/VisitsTicket_idResourceAttribute", "exampleSetFlag" : false }, "photo_ident" : { "$ref" : "#/components/schemas/VisitsPhoto_identResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "tkpDistrict" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/relationships/tkpDistrict" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/tkpDistrict" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TkpDistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dueDateExtensions" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/relationships/dueDateExtensions" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/dueDateExtensions" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "ticket" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/relationships/ticket" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/ticket" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TicketsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "activities" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/relationships/activities" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/activities" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "visitLocation" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/relationships/visitLocation" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}/visitLocation" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitLocationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/VisitLocationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsActivitiesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/ActivitiesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "VisitsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VisitsPostResourceReference", "exampleSetFlag" : false } ] }, "VisitsVisitLocationResourceAttribute" : { "$ref" : "#/components/schemas/VisitLocationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VisitsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VisitsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VisitsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VisitsResourceLinks", "exampleSetFlag" : false } ] }, "VisitsDepartedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VisitsDueDateExtensionsResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "VisitsWhen_saved_localResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VisitsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VisitsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VisitsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (visits)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "visits" ] }, "id" : { "$ref" : "#/components/schemas/VisitsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsPhoto_identResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VisitsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VisitsActor_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VisitsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VisitsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/VisitsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "VisitsSynced_upResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VisitsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/ticketpro/1.0/visits/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "VisitsArrivedResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VisitsTicketResourceAttribute" : { "$ref" : "#/components/schemas/TicketsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VotesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VotesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "VotesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VotesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/votes/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesVoter_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VotesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "idea" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/votes/{id}/relationships/idea" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/votes/{id}/idea" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/IdeasResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/votes/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/idea/1.0/votes/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (votes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "votes" ] }, "id" : { "$ref" : "#/components/schemas/VotesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "VotesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VotesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VotesResourcePostAttributes", "exampleSetFlag" : false } ] }, "VotesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VotesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/VotesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "vote_type" : { "$ref" : "#/components/schemas/VotesVote_typeResourceAttribute", "exampleSetFlag" : false }, "voter_id" : { "$ref" : "#/components/schemas/VotesVoter_idResourceAttribute", "exampleSetFlag" : false }, "idea_id" : { "$ref" : "#/components/schemas/VotesIdea_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/VotesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VotesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VotesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VotesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VotesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VotesResourceLinks", "exampleSetFlag" : false } ] }, "VotesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VotesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/VotesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/VotesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/VotesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "VotesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/VotesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "vote_type" : { "$ref" : "#/components/schemas/VotesVote_typeResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/VotesCreated_onResourceAttribute", "exampleSetFlag" : false }, "voter_id" : { "$ref" : "#/components/schemas/VotesVoter_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VotesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "idea_id" : { "$ref" : "#/components/schemas/VotesIdea_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/VotesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/VotesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VotesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "last_updated_by" : { "$ref" : "#/components/schemas/VotesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "vote_type" : { "$ref" : "#/components/schemas/VotesVote_typeResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/VotesCreated_onResourceAttribute", "exampleSetFlag" : false }, "voter_id" : { "$ref" : "#/components/schemas/VotesVoter_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/VotesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "idea_id" : { "$ref" : "#/components/schemas/VotesIdea_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/VotesCreated_byResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesVote_typeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "VotesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "VotesIdea_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VotesIdeaResourceAttribute" : { "$ref" : "#/components/schemas/IdeasResourceReference", "nullable" : true, "exampleSetFlag" : false }, "VotesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "VotesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (votes)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "votes" ] }, "id" : { "$ref" : "#/components/schemas/VotesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "VotesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/VotesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsResultResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "owner" : { "$ref" : "#/components/schemas/WfNotificationsOwnerResourceAttribute", "exampleSetFlag" : false }, "process_id" : { "$ref" : "#/components/schemas/WfNotificationsProcess_idResourceAttribute", "exampleSetFlag" : false }, "activity_name" : { "$ref" : "#/components/schemas/WfNotificationsActivity_nameResourceAttribute", "exampleSetFlag" : false }, "idType" : { "$ref" : "#/components/schemas/WfNotificationsIdTypeResourceAttribute", "exampleSetFlag" : false }, "next_step_url" : { "$ref" : "#/components/schemas/WfNotificationsNext_step_urlResourceAttribute", "exampleSetFlag" : false }, "idvalue" : { "$ref" : "#/components/schemas/WfNotificationsIdvalueResourceAttribute", "exampleSetFlag" : false }, "step_id" : { "$ref" : "#/components/schemas/WfNotificationsStep_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WfNotificationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/WfNotificationsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/WfNotificationsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "id_column_table" : { "$ref" : "#/components/schemas/WfNotificationsId_column_tableResourceAttribute", "exampleSetFlag" : false }, "result" : { "$ref" : "#/components/schemas/WfNotificationsResultResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WfNotificationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/WfNotificationsStatus_idResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/WfNotificationsActivity_idResourceAttribute", "exampleSetFlag" : false }, "text" : { "$ref" : "#/components/schemas/WfNotificationsTextResourceAttribute", "exampleSetFlag" : false }, "remarks" : { "$ref" : "#/components/schemas/WfNotificationsRemarksResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WfNotificationsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/wfNotifications/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wfNotifications)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wfNotifications" ] }, "id" : { "$ref" : "#/components/schemas/WfNotificationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "WfNotificationsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsWfNotificationsArchivesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "WfNotificationsLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "WfNotificationsProcess_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "owner" : { "$ref" : "#/components/schemas/WfNotificationsOwnerResourceAttribute", "exampleSetFlag" : false }, "process_id" : { "$ref" : "#/components/schemas/WfNotificationsProcess_idResourceAttribute", "exampleSetFlag" : false }, "activity_name" : { "$ref" : "#/components/schemas/WfNotificationsActivity_nameResourceAttribute", "exampleSetFlag" : false }, "idType" : { "$ref" : "#/components/schemas/WfNotificationsIdTypeResourceAttribute", "exampleSetFlag" : false }, "next_step_url" : { "$ref" : "#/components/schemas/WfNotificationsNext_step_urlResourceAttribute", "exampleSetFlag" : false }, "idvalue" : { "$ref" : "#/components/schemas/WfNotificationsIdvalueResourceAttribute", "exampleSetFlag" : false }, "step_id" : { "$ref" : "#/components/schemas/WfNotificationsStep_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WfNotificationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/WfNotificationsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/WfNotificationsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "id_column_table" : { "$ref" : "#/components/schemas/WfNotificationsId_column_tableResourceAttribute", "exampleSetFlag" : false }, "result" : { "$ref" : "#/components/schemas/WfNotificationsResultResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WfNotificationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/WfNotificationsStatus_idResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/WfNotificationsCreated_onResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/WfNotificationsActivity_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/WfNotificationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "text" : { "$ref" : "#/components/schemas/WfNotificationsTextResourceAttribute", "exampleSetFlag" : false }, "remarks" : { "$ref" : "#/components/schemas/WfNotificationsRemarksResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/WfNotificationsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "WfNotificationsIdvalueResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsStatus_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "policyDropOffEstimates" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/wfNotifications/{id}/relationships/policyDropOffEstimates" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/wfNotifications/{id}/policyDropOffEstimates" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "wfNotificationsArchives" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/wfNotifications/{id}/relationships/wfNotificationsArchives" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/wfNotifications/{id}/wfNotificationsArchives" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "types" : [ "array" ] }, { "uniqueItems" : true, "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsActivity_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsRemarksResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wfNotifications)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wfNotifications" ] }, "id" : { "$ref" : "#/components/schemas/WfNotificationsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WfNotificationsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsResourcePostAttributes", "exampleSetFlag" : false } ] }, "WfNotificationsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsId_column_tableResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "WfNotificationsIdTypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsStep_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsActivity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsNext_step_urlResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsOwnerResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsTextResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "WfNotificationsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "owner" : { "$ref" : "#/components/schemas/WfNotificationsOwnerResourceAttribute", "exampleSetFlag" : false }, "process_id" : { "$ref" : "#/components/schemas/WfNotificationsProcess_idResourceAttribute", "exampleSetFlag" : false }, "activity_name" : { "$ref" : "#/components/schemas/WfNotificationsActivity_nameResourceAttribute", "exampleSetFlag" : false }, "idType" : { "$ref" : "#/components/schemas/WfNotificationsIdTypeResourceAttribute", "exampleSetFlag" : false }, "next_step_url" : { "$ref" : "#/components/schemas/WfNotificationsNext_step_urlResourceAttribute", "exampleSetFlag" : false }, "idvalue" : { "$ref" : "#/components/schemas/WfNotificationsIdvalueResourceAttribute", "exampleSetFlag" : false }, "step_id" : { "$ref" : "#/components/schemas/WfNotificationsStep_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WfNotificationsCreated_byResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/WfNotificationsWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/WfNotificationsCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "id_column_table" : { "$ref" : "#/components/schemas/WfNotificationsId_column_tableResourceAttribute", "exampleSetFlag" : false }, "result" : { "$ref" : "#/components/schemas/WfNotificationsResultResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WfNotificationsLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/WfNotificationsStatus_idResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/WfNotificationsActivity_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/WfNotificationsLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "text" : { "$ref" : "#/components/schemas/WfNotificationsTextResourceAttribute", "exampleSetFlag" : false }, "remarks" : { "$ref" : "#/components/schemas/WfNotificationsRemarksResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsResourceLinks", "exampleSetFlag" : false } ] }, "WfNotificationsPolicyDropOffEstimatesResourceAttribute" : { "uniqueItems" : true, "type" : "array", "nullable" : true, "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, "WfNotificationsArchivesCompleted_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "WfNotificationsArchivesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "WfNotificationsArchivesId_column_tableResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsArchivesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsArchivesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsArchivesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsArchivesStatus_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsArchivesNext_step_urlResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsArchivesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "wfNotification" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/wfNotificationsArchives/{id}/relationships/wfNotification" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/wfNotificationsArchives/{id}/wfNotification" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesArchive_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "WfNotificationsArchivesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WfNotificationsArchivesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsArchivesResourcePostAttributes", "exampleSetFlag" : false } ] }, "WfNotificationsArchivesWf_item_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsArchivesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "owner" : { "$ref" : "#/components/schemas/WfNotificationsArchivesOwnerResourceAttribute", "exampleSetFlag" : false }, "process_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesProcess_idResourceAttribute", "exampleSetFlag" : false }, "activity_name" : { "$ref" : "#/components/schemas/WfNotificationsArchivesActivity_nameResourceAttribute", "exampleSetFlag" : false }, "idType" : { "$ref" : "#/components/schemas/WfNotificationsArchivesIdTypeResourceAttribute", "exampleSetFlag" : false }, "next_step_url" : { "$ref" : "#/components/schemas/WfNotificationsArchivesNext_step_urlResourceAttribute", "exampleSetFlag" : false }, "idvalue" : { "$ref" : "#/components/schemas/WfNotificationsArchivesIdvalueResourceAttribute", "exampleSetFlag" : false }, "notification_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesNotification_idResourceAttribute", "exampleSetFlag" : false }, "step_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesStep_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WfNotificationsArchivesCreated_byResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/WfNotificationsArchivesCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "id_column_table" : { "$ref" : "#/components/schemas/WfNotificationsArchivesId_column_tableResourceAttribute", "exampleSetFlag" : false }, "result" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResultResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WfNotificationsArchivesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesStatus_idResourceAttribute", "exampleSetFlag" : false }, "archive_date" : { "$ref" : "#/components/schemas/WfNotificationsArchivesArchive_dateResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/WfNotificationsArchivesCreated_onResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesActivity_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/WfNotificationsArchivesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "text" : { "$ref" : "#/components/schemas/WfNotificationsArchivesTextResourceAttribute", "exampleSetFlag" : false }, "remarks" : { "$ref" : "#/components/schemas/WfNotificationsArchivesRemarksResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/cms/1.0/wfNotificationsArchives/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WfNotificationsArchivesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesActivity_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsArchivesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wfNotificationsArchives)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wfNotificationsArchives" ] }, "id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesIdTypeResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsArchivesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "owner" : { "$ref" : "#/components/schemas/WfNotificationsArchivesOwnerResourceAttribute", "exampleSetFlag" : false }, "process_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesProcess_idResourceAttribute", "exampleSetFlag" : false }, "activity_name" : { "$ref" : "#/components/schemas/WfNotificationsArchivesActivity_nameResourceAttribute", "exampleSetFlag" : false }, "idType" : { "$ref" : "#/components/schemas/WfNotificationsArchivesIdTypeResourceAttribute", "exampleSetFlag" : false }, "next_step_url" : { "$ref" : "#/components/schemas/WfNotificationsArchivesNext_step_urlResourceAttribute", "exampleSetFlag" : false }, "idvalue" : { "$ref" : "#/components/schemas/WfNotificationsArchivesIdvalueResourceAttribute", "exampleSetFlag" : false }, "notification_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesNotification_idResourceAttribute", "exampleSetFlag" : false }, "step_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesStep_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WfNotificationsArchivesCreated_byResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/WfNotificationsArchivesCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "id_column_table" : { "$ref" : "#/components/schemas/WfNotificationsArchivesId_column_tableResourceAttribute", "exampleSetFlag" : false }, "result" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResultResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WfNotificationsArchivesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesStatus_idResourceAttribute", "exampleSetFlag" : false }, "archive_date" : { "$ref" : "#/components/schemas/WfNotificationsArchivesArchive_dateResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesActivity_idResourceAttribute", "exampleSetFlag" : false }, "text" : { "$ref" : "#/components/schemas/WfNotificationsArchivesTextResourceAttribute", "exampleSetFlag" : false }, "remarks" : { "$ref" : "#/components/schemas/WfNotificationsArchivesRemarksResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesStep_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsArchivesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wfNotificationsArchives)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wfNotificationsArchives" ] }, "id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "WfNotificationsArchivesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsArchivesResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesActivity_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsArchivesNotification_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsArchivesTextResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsArchivesResultResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsArchivesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceLinks", "exampleSetFlag" : false } ] }, "WfNotificationsArchivesIdvalueResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsArchivesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "owner" : { "$ref" : "#/components/schemas/WfNotificationsArchivesOwnerResourceAttribute", "exampleSetFlag" : false }, "process_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesProcess_idResourceAttribute", "exampleSetFlag" : false }, "activity_name" : { "$ref" : "#/components/schemas/WfNotificationsArchivesActivity_nameResourceAttribute", "exampleSetFlag" : false }, "idType" : { "$ref" : "#/components/schemas/WfNotificationsArchivesIdTypeResourceAttribute", "exampleSetFlag" : false }, "next_step_url" : { "$ref" : "#/components/schemas/WfNotificationsArchivesNext_step_urlResourceAttribute", "exampleSetFlag" : false }, "idvalue" : { "$ref" : "#/components/schemas/WfNotificationsArchivesIdvalueResourceAttribute", "exampleSetFlag" : false }, "notification_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesNotification_idResourceAttribute", "exampleSetFlag" : false }, "step_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesStep_idResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WfNotificationsArchivesCreated_byResourceAttribute", "exampleSetFlag" : false }, "wf_item_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesWf_item_idResourceAttribute", "exampleSetFlag" : false }, "completed_date" : { "$ref" : "#/components/schemas/WfNotificationsArchivesCompleted_dateResourceAttribute", "exampleSetFlag" : false }, "id_column_table" : { "$ref" : "#/components/schemas/WfNotificationsArchivesId_column_tableResourceAttribute", "exampleSetFlag" : false }, "result" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResultResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WfNotificationsArchivesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "status_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesStatus_idResourceAttribute", "exampleSetFlag" : false }, "archive_date" : { "$ref" : "#/components/schemas/WfNotificationsArchivesArchive_dateResourceAttribute", "exampleSetFlag" : false }, "activity_id" : { "$ref" : "#/components/schemas/WfNotificationsArchivesActivity_idResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/WfNotificationsArchivesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "text" : { "$ref" : "#/components/schemas/WfNotificationsArchivesTextResourceAttribute", "exampleSetFlag" : false }, "remarks" : { "$ref" : "#/components/schemas/WfNotificationsArchivesRemarksResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WfNotificationsArchivesRemarksResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WfNotificationsArchivesOwnerResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsArchivesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "WfNotificationsArchivesWfNotificationResourceAttribute" : { "$ref" : "#/components/schemas/WfNotificationsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "WfNotificationsArchivesProcess_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WfNotificationsArchivesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "WfNotificationsArchivesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WfNotificationsArchivesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesEmployee_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WirelessInventoriesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WirelessInventoriesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesImeiResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesTotal_chargesResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WirelessInventoriesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "WirelessInventoriesVoice_usageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesEmployeeOnLoanResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "nullable" : true, "exampleSetFlag" : false }, "WirelessInventoriesText_usageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wirelessInventories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wirelessInventories" ] }, "id" : { "$ref" : "#/components/schemas/WirelessInventoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WirelessInventoriesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesDistResourceAttribute" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "nullable" : true, "exampleSetFlag" : false }, "WirelessInventoriesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WirelessInventoriesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WirelessInventoriesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WirelessInventoriesResourceLinks", "exampleSetFlag" : false } ] }, "WirelessInventoriesWireless_vendorResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesDistrict_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WirelessInventoriesSim_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "employeeOnLoan" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/wirelessInventories/{id}/relationships/employeeOnLoan" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/wirelessInventories/{id}/employeeOnLoan" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "dist" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/wirelessInventories/{id}/relationships/dist" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/wirelessInventories/{id}/dist" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/DistrictsResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "employee" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/wirelessInventories/{id}/relationships/employee" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/wirelessInventories/{id}/employee" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/EmployeesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesData_usageResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesIdResourceAttribute" : { "type" : "string", "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesContract_end_dateResourceAttribute" : { "type" : "string", "format" : "date", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "wireless_number" : { "$ref" : "#/components/schemas/WirelessInventoriesWireless_numberResourceAttribute", "exampleSetFlag" : false }, "wireless_vendor" : { "$ref" : "#/components/schemas/WirelessInventoriesWireless_vendorResourceAttribute", "exampleSetFlag" : false }, "device_model" : { "$ref" : "#/components/schemas/WirelessInventoriesDevice_modelResourceAttribute", "exampleSetFlag" : false }, "wireless_user_status" : { "$ref" : "#/components/schemas/WirelessInventoriesWireless_user_statusResourceAttribute", "exampleSetFlag" : false }, "text_usage" : { "$ref" : "#/components/schemas/WirelessInventoriesText_usageResourceAttribute", "exampleSetFlag" : false }, "wireless_user_full_name" : { "$ref" : "#/components/schemas/WirelessInventoriesWireless_user_full_nameResourceAttribute", "exampleSetFlag" : false }, "sim_number" : { "$ref" : "#/components/schemas/WirelessInventoriesSim_numberResourceAttribute", "exampleSetFlag" : false }, "data_usage" : { "$ref" : "#/components/schemas/WirelessInventoriesData_usageResourceAttribute", "exampleSetFlag" : false }, "contract_end_date" : { "$ref" : "#/components/schemas/WirelessInventoriesContract_end_dateResourceAttribute", "exampleSetFlag" : false }, "total_charges" : { "$ref" : "#/components/schemas/WirelessInventoriesTotal_chargesResourceAttribute", "exampleSetFlag" : false }, "voice_usage" : { "$ref" : "#/components/schemas/WirelessInventoriesVoice_usageResourceAttribute", "exampleSetFlag" : false }, "employee_id" : { "$ref" : "#/components/schemas/WirelessInventoriesEmployee_idResourceAttribute", "exampleSetFlag" : false }, "usage_last_updated_on" : { "$ref" : "#/components/schemas/WirelessInventoriesUsage_last_updated_onResourceAttribute", "exampleSetFlag" : false }, "imei" : { "$ref" : "#/components/schemas/WirelessInventoriesImeiResourceAttribute", "exampleSetFlag" : false }, "truck_vin" : { "$ref" : "#/components/schemas/WirelessInventoriesTruck_vinResourceAttribute", "exampleSetFlag" : false }, "district_id" : { "$ref" : "#/components/schemas/WirelessInventoriesDistrict_idResourceAttribute", "exampleSetFlag" : false }, "device_last_updated_on" : { "$ref" : "#/components/schemas/WirelessInventoriesDevice_last_updated_onResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesWireless_user_full_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesTruck_vinResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wirelessInventories)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wirelessInventories" ] }, "id" : { "$ref" : "#/components/schemas/WirelessInventoriesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesDevice_modelResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesWireless_user_statusResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/assetmanager/1.0/wirelessInventories/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesDevice_last_updated_onResourceAttribute" : { "type" : "string", "format" : "date", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesEmployeeResourceAttribute" : { "$ref" : "#/components/schemas/EmployeesResourceReference", "nullable" : true, "exampleSetFlag" : false }, "WirelessInventoriesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "WirelessInventoriesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesWireless_numberResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesUsage_last_updated_onResourceAttribute" : { "type" : "string", "format" : "date", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WirelessInventoriesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WirelessInventoriesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WirelessInventoriesPostResourceReference", "exampleSetFlag" : false } ] }, "WsUserAccessesNamespaceResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUserAccessesToken_idResourceAttribute" : { "type" : "integer", "format" : "int64", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WsUserAccessesResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUserAccessesResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUserAccessesResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUserAccessesResourceLinks", "exampleSetFlag" : false } ] }, "WsUserAccessesResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/WsUserAccessesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WsUserAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "token_id" : { "$ref" : "#/components/schemas/WsUserAccessesToken_idResourceAttribute", "exampleSetFlag" : false }, "classs" : { "$ref" : "#/components/schemas/WsUserAccessesClasssResourceAttribute", "exampleSetFlag" : false }, "method" : { "$ref" : "#/components/schemas/WsUserAccessesMethodResourceAttribute", "exampleSetFlag" : false }, "namespace" : { "$ref" : "#/components/schemas/WsUserAccessesNamespaceResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/WsUserAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WsUserAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/WsUserAccessesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesMethodResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUserAccessesCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "WsUserAccessesPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WsUserAccessesPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WsUserAccessesResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/wsUserAccesses/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "token" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUserAccessesPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUserAccessesResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUserAccessesResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "token" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/WsUserAccessesResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "WsUserAccessesResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/WsUserAccessesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WsUserAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "token_id" : { "$ref" : "#/components/schemas/WsUserAccessesToken_idResourceAttribute", "exampleSetFlag" : false }, "classs" : { "$ref" : "#/components/schemas/WsUserAccessesClasssResourceAttribute", "exampleSetFlag" : false }, "method" : { "$ref" : "#/components/schemas/WsUserAccessesMethodResourceAttribute", "exampleSetFlag" : false }, "namespace" : { "$ref" : "#/components/schemas/WsUserAccessesNamespaceResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WsUserAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/WsUserAccessesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesClasssResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUserAccessesResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "token" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/wsUserAccesses/{id}/relationships/token" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/wsUserAccesses/{id}/token" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WsUserAccessesPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUserAccessesResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUserAccessesResourcePostRelationships", "exampleSetFlag" : false } ] }, "WsUserAccessesPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "WsUserAccessesStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "WsUserAccessesLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "WsUserAccessesTokenResourceAttribute" : { "$ref" : "#/components/schemas/TokensResourceReference", "nullable" : true, "exampleSetFlag" : false }, "WsUserAccessesLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUserAccessesResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wsUserAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wsUserAccesses" ] }, "id" : { "$ref" : "#/components/schemas/WsUserAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUserAccessesResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "WsUserAccessesPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wsUserAccesses)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wsUserAccesses" ] }, "id" : { "$ref" : "#/components/schemas/WsUserAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUserAccessesResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/WsUserAccessesEnd_dateResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WsUserAccessesLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "token_id" : { "$ref" : "#/components/schemas/WsUserAccessesToken_idResourceAttribute", "exampleSetFlag" : false }, "classs" : { "$ref" : "#/components/schemas/WsUserAccessesClasssResourceAttribute", "exampleSetFlag" : false }, "method" : { "$ref" : "#/components/schemas/WsUserAccessesMethodResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/WsUserAccessesCreated_onResourceAttribute", "exampleSetFlag" : false }, "namespace" : { "$ref" : "#/components/schemas/WsUserAccessesNamespaceResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/WsUserAccessesLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WsUserAccessesCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/WsUserAccessesStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/WsUsersEnd_dateResourceAttribute", "exampleSetFlag" : false }, "password" : { "$ref" : "#/components/schemas/WsUsersPasswordResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WsUsersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "entity_name" : { "$ref" : "#/components/schemas/WsUsersEntity_nameResourceAttribute", "exampleSetFlag" : false }, "user_name" : { "$ref" : "#/components/schemas/WsUsersUser_nameResourceAttribute", "exampleSetFlag" : false }, "new_password" : { "$ref" : "#/components/schemas/WsUsersNew_passwordResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/WsUsersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WsUsersCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/WsUsersStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wsUsers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wsUsers" ] }, "id" : { "$ref" : "#/components/schemas/WsUsersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wsUsers)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wsUsers" ] }, "id" : { "$ref" : "#/components/schemas/WsUsersIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersEnd_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "WsUsersResourcePostRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "token" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersIdResourceAttribute" : { "type" : "integer", "description" : "The JSON:API resource ID", "format" : "int64", "nullable" : false, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WsUsersLast_updated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUsersResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersNew_passwordResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUsersPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WsUsersPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUsersResourcePostAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUsersResourcePostRelationships", "exampleSetFlag" : false } ] }, "WsUsersCreated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "WsUsersResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUsersResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUsersResourceRelationships", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUsersResourceLinks", "exampleSetFlag" : false } ] }, "WsUsersPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WsUsersPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersEntity_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUsersResourcePatchRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "token" : { "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersStart_dateResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : true, "exampleSetFlag" : false }, "WsUsersCreated_byResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUsersResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/wsUsers/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUsersResourcePatchAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsUsersResourcePatchRelationships", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersPasswordResourceAttribute" : { "type" : "string", "format" : "byte", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUsersResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUsersResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "WsUsersResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/WsUsersEnd_dateResourceAttribute", "exampleSetFlag" : false }, "password" : { "$ref" : "#/components/schemas/WsUsersPasswordResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WsUsersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "entity_name" : { "$ref" : "#/components/schemas/WsUsersEntity_nameResourceAttribute", "exampleSetFlag" : false }, "user_name" : { "$ref" : "#/components/schemas/WsUsersUser_nameResourceAttribute", "exampleSetFlag" : false }, "new_password" : { "$ref" : "#/components/schemas/WsUsersNew_passwordResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WsUsersCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/WsUsersStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersLast_updated_onResourceAttribute" : { "type" : "string", "format" : "date-time", "nullable" : false, "exampleSetFlag" : false }, "WsUsersResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WsUsersResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersTokenResourceAttribute" : { "$ref" : "#/components/schemas/TokensResourceReference", "nullable" : false, "exampleSetFlag" : false }, "WsUsersResourceRelationships" : { "type" : "object", "properties" : { "relationships" : { "type" : "object", "properties" : { "token" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/wsUsers/{id}/relationships/token" }, "related" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/webservices/1.0/wsUsers/{id}/token" } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "data" : { "exampleSetFlag" : false, "oneOf" : [ { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] }, { "$ref" : "#/components/schemas/TokensResourceReference", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Relationships between the resource and other JSON:API resources", "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "end_date" : { "$ref" : "#/components/schemas/WsUsersEnd_dateResourceAttribute", "exampleSetFlag" : false }, "password" : { "$ref" : "#/components/schemas/WsUsersPasswordResourceAttribute", "exampleSetFlag" : false }, "last_updated_by" : { "$ref" : "#/components/schemas/WsUsersLast_updated_byResourceAttribute", "exampleSetFlag" : false }, "entity_name" : { "$ref" : "#/components/schemas/WsUsersEntity_nameResourceAttribute", "exampleSetFlag" : false }, "created_on" : { "$ref" : "#/components/schemas/WsUsersCreated_onResourceAttribute", "exampleSetFlag" : false }, "user_name" : { "$ref" : "#/components/schemas/WsUsersUser_nameResourceAttribute", "exampleSetFlag" : false }, "new_password" : { "$ref" : "#/components/schemas/WsUsersNew_passwordResourceAttribute", "exampleSetFlag" : false }, "last_updated_on" : { "$ref" : "#/components/schemas/WsUsersLast_updated_onResourceAttribute", "exampleSetFlag" : false }, "created_by" : { "$ref" : "#/components/schemas/WsUsersCreated_byResourceAttribute", "exampleSetFlag" : false }, "start_date" : { "$ref" : "#/components/schemas/WsUsersStart_dateResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsUsersResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/WsUsersResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "WsUsersUser_nameResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsUsersPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsUsersPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsResourceReference" : { "required" : [ "id", "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wsvLocByContracts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wsvLocByContracts" ] }, "id" : { "$ref" : "#/components/schemas/WsvLocByContractsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsCREATED_DTTMResourceAttribute" : { "type" : "timestamp", "nullable" : true, "exampleSetFlag" : false }, "WsvLocByContractsROW_CHECKSUMResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WsvLocByContractsPostResourceReference" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The JSON:API resource type (wsvLocByContracts)", "exampleSetFlag" : false, "types" : [ "string" ], "enum" : [ "wsvLocByContracts" ] }, "id" : { "$ref" : "#/components/schemas/WsvLocByContractsIdResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsCLOSED_CTResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WsvLocByContractsACCOUNT_NAMEResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsvLocByContractsCAL_YEARResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WsvLocByContractsResourceResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "$ref" : "#/components/schemas/WsvLocByContractsResourceSchema", "exampleSetFlag" : false } }, "exampleSetFlag" : false } ] }, "WsvLocByContractsResourceSchema" : { "required" : [ "attributes" ], "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WsvLocByContractsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsvLocByContractsResourceAttributes", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsvLocByContractsResourceLinks", "exampleSetFlag" : false } ] }, "WsvLocByContractsIdResourceAttribute" : { "type" : "object", "properties" : { "cALENDAR_DATE" : { "type" : "timestamp", "exampleSetFlag" : false }, "aCCOUNT_NUMBER" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] }, "cONTRACT_NUMBER" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ] } }, "description" : "The JSON:API resource ID", "nullable" : false, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsPostResources" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsvLocByContractsPostResourceData", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsPostResourceData" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WsvLocByContractsPostResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsvLocByContractsResourcePostAttributes", "exampleSetFlag" : false } ] }, "WsvLocByContractsResourcePatchAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cALENDAR_DATE" : { "$ref" : "#/components/schemas/WsvLocByContractsCALENDAR_DATEResourceAttribute", "exampleSetFlag" : false }, "rOW_CHECKSUM" : { "$ref" : "#/components/schemas/WsvLocByContractsROW_CHECKSUMResourceAttribute", "exampleSetFlag" : false }, "cAL_YEAR" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_YEARResourceAttribute", "exampleSetFlag" : false }, "cAL_MONTH" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_MONTHResourceAttribute", "exampleSetFlag" : false }, "cREATED_DTTM" : { "$ref" : "#/components/schemas/WsvLocByContractsCREATED_DTTMResourceAttribute", "exampleSetFlag" : false }, "cONTRACT_NUMBER" : { "$ref" : "#/components/schemas/WsvLocByContractsCONTRACT_NUMBERResourceAttribute", "exampleSetFlag" : false }, "cAL_WEEK_YEAR" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_WEEK_YEARResourceAttribute", "exampleSetFlag" : false }, "cAL_WEEK_IN_YEAR" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_WEEK_IN_YEARResourceAttribute", "exampleSetFlag" : false }, "aCCOUNT_NUMBER" : { "$ref" : "#/components/schemas/WsvLocByContractsACCOUNT_NUMBERResourceAttribute", "exampleSetFlag" : false }, "aCCOUNT_NAME" : { "$ref" : "#/components/schemas/WsvLocByContractsACCOUNT_NAMEResourceAttribute", "exampleSetFlag" : false }, "cLOSED_CT" : { "$ref" : "#/components/schemas/WsvLocByContractsCLOSED_CTResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsACCOUNT_NUMBERResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsvLocByContractsCAL_WEEK_IN_YEARResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WsvLocByContractsResourceAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cALENDAR_DATE" : { "$ref" : "#/components/schemas/WsvLocByContractsCALENDAR_DATEResourceAttribute", "exampleSetFlag" : false }, "rOW_CHECKSUM" : { "$ref" : "#/components/schemas/WsvLocByContractsROW_CHECKSUMResourceAttribute", "exampleSetFlag" : false }, "cAL_YEAR" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_YEARResourceAttribute", "exampleSetFlag" : false }, "cAL_MONTH" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_MONTHResourceAttribute", "exampleSetFlag" : false }, "cREATED_DTTM" : { "$ref" : "#/components/schemas/WsvLocByContractsCREATED_DTTMResourceAttribute", "exampleSetFlag" : false }, "cONTRACT_NUMBER" : { "$ref" : "#/components/schemas/WsvLocByContractsCONTRACT_NUMBERResourceAttribute", "exampleSetFlag" : false }, "oPENED_CT" : { "$ref" : "#/components/schemas/WsvLocByContractsOPENED_CTResourceAttribute", "exampleSetFlag" : false }, "cAL_WEEK_YEAR" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_WEEK_YEARResourceAttribute", "exampleSetFlag" : false }, "cAL_WEEK_IN_YEAR" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_WEEK_IN_YEARResourceAttribute", "exampleSetFlag" : false }, "aCCOUNT_NUMBER" : { "$ref" : "#/components/schemas/WsvLocByContractsACCOUNT_NUMBERResourceAttribute", "exampleSetFlag" : false }, "aCCOUNT_NAME" : { "$ref" : "#/components/schemas/WsvLocByContractsACCOUNT_NAMEResourceAttribute", "exampleSetFlag" : false }, "cLOSED_CT" : { "$ref" : "#/components/schemas/WsvLocByContractsCLOSED_CTResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsPostResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WsvLocByContractsPostResourceData", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsResourcePostAttributes" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "properties" : { "cALENDAR_DATE" : { "$ref" : "#/components/schemas/WsvLocByContractsCALENDAR_DATEResourceAttribute", "exampleSetFlag" : false }, "rOW_CHECKSUM" : { "$ref" : "#/components/schemas/WsvLocByContractsROW_CHECKSUMResourceAttribute", "exampleSetFlag" : false }, "cAL_YEAR" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_YEARResourceAttribute", "exampleSetFlag" : false }, "cAL_MONTH" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_MONTHResourceAttribute", "exampleSetFlag" : false }, "cREATED_DTTM" : { "$ref" : "#/components/schemas/WsvLocByContractsCREATED_DTTMResourceAttribute", "exampleSetFlag" : false }, "cONTRACT_NUMBER" : { "$ref" : "#/components/schemas/WsvLocByContractsCONTRACT_NUMBERResourceAttribute", "exampleSetFlag" : false }, "cAL_WEEK_YEAR" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_WEEK_YEARResourceAttribute", "exampleSetFlag" : false }, "cAL_WEEK_IN_YEAR" : { "$ref" : "#/components/schemas/WsvLocByContractsCAL_WEEK_IN_YEARResourceAttribute", "exampleSetFlag" : false }, "aCCOUNT_NUMBER" : { "$ref" : "#/components/schemas/WsvLocByContractsACCOUNT_NUMBERResourceAttribute", "exampleSetFlag" : false }, "aCCOUNT_NAME" : { "$ref" : "#/components/schemas/WsvLocByContractsACCOUNT_NAMEResourceAttribute", "exampleSetFlag" : false }, "cLOSED_CT" : { "$ref" : "#/components/schemas/WsvLocByContractsCLOSED_CTResourceAttribute", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsPatchResource" : { "required" : [ "data" ], "type" : "object", "properties" : { "data" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/WsvLocByContractsResourceReference", "exampleSetFlag" : false }, { "$ref" : "#/components/schemas/WsvLocByContractsResourcePatchAttributes", "exampleSetFlag" : false } ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsResourceReferenceResponseSchema" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/WsvLocByContractsResourceReference", "exampleSetFlag" : false } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsCONTRACT_NUMBERResourceAttribute" : { "type" : "string", "nullable" : true, "exampleSetFlag" : false, "types" : [ "string" ] }, "WsvLocByContractsResourcesResponseSchema" : { "exampleSetFlag" : false, "allOf" : [ { "$ref" : "#/components/schemas/Success", "exampleSetFlag" : false }, { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsvLocByContractsResourceSchema", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false } ] }, "WsvLocByContractsResourceLinks" : { "type" : "object", "properties" : { "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "format" : "uri", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "/customerportal/1.0/wsvLocByContracts/{id}" } }, "additionalProperties" : { "$ref" : "#/components/schemas/Link", "exampleSetFlag" : false }, "exampleSetFlag" : false, "types" : [ "object" ] } }, "description" : "Links related to the resource", "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsResourceReferencesResponseSchema" : { "type" : "object", "properties" : { "data" : { "type" : "array", "exampleSetFlag" : false, "items" : { "$ref" : "#/components/schemas/WsvLocByContractsResourceReference", "exampleSetFlag" : false }, "types" : [ "array" ] } }, "exampleSetFlag" : false, "types" : [ "object" ] }, "WsvLocByContractsCALENDAR_DATEResourceAttribute" : { "type" : "timestamp", "nullable" : true, "exampleSetFlag" : false }, "WsvLocByContractsCAL_WEEK_YEARResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WsvLocByContractsOPENED_CTResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "WsvLocByContractsCAL_MONTHResourceAttribute" : { "type" : "integer", "format" : "int32", "nullable" : true, "exampleSetFlag" : false, "types" : [ "integer" ] }, "RegistrationResponseJson" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "rawId" : { "type" : "string" }, "type" : { "type" : "string" }, "response" : { "$ref" : "#/components/schemas/Response" } } }, "Response" : { "type" : "object", "properties" : { "attestationObject" : { "type" : "string" }, "clientDataJSON" : { "type" : "string" } } }, "WebAuthnRegistrationRequest" : { "type" : "object", "properties" : { "username" : { "type" : "string" }, "token" : { "type" : "string" }, "registrationResponseJson" : { "$ref" : "#/components/schemas/RegistrationResponseJson" }, "attestationObject" : { "$ref" : "#/components/schemas/RegistrationResponseJson" } } }, "WebAuthnOptionsRequest" : { "type" : "object", "properties" : { "username" : { "type" : "string" }, "userName" : { "type" : "string", "writeOnly" : true } } }, "AuthenticationExtensionsClientInputsRegistrationExtensionClientInput" : { "type" : "object", "properties" : { "appid" : { "type" : "string" }, "appidExclude" : { "type" : "string" }, "uvm" : { "type" : "boolean" }, "credProps" : { "type" : "boolean" }, "credentialProtectionPolicy" : { "type" : "string", "enum" : [ "userVerificationOptional", "userVerificationOptionalWithCredentialIDList", "userVerificationRequired" ] }, "enforceCredentialProtectionPolicy" : { "type" : "boolean" }, "hmacCreateSecret" : { "type" : "boolean" }, "hmacGetSecret" : { "$ref" : "#/components/schemas/HMACGetSecretInput" } } }, "AuthenticatorSelectionCriteria" : { "type" : "object", "properties" : { "authenticatorAttachment" : { "type" : "string" }, "requireResidentKey" : { "type" : "boolean" }, "residentKey" : { "type" : "string" }, "userVerification" : { "type" : "string" } } }, "Challenge" : { "type" : "object", "properties" : { "value" : { "type" : "string", "format" : "byte" } } }, "HMACGetSecretInput" : { "type" : "object", "properties" : { "salt1" : { "type" : "string", "format" : "byte" }, "salt2" : { "type" : "string", "format" : "byte" } } }, "PublicKeyCredentialCreationOptions" : { "type" : "object", "properties" : { "rp" : { "$ref" : "#/components/schemas/PublicKeyCredentialRpEntity" }, "user" : { "$ref" : "#/components/schemas/PublicKeyCredentialUserEntity" }, "challenge" : { "$ref" : "#/components/schemas/Challenge" }, "pubKeyCredParams" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PublicKeyCredentialParameters" } }, "timeout" : { "type" : "integer", "format" : "int64" }, "excludeCredentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PublicKeyCredentialDescriptor" } }, "authenticatorSelection" : { "$ref" : "#/components/schemas/AuthenticatorSelectionCriteria" }, "hints" : { "type" : "array", "items" : { "type" : "string" } }, "attestation" : { "type" : "string" }, "extensions" : { "$ref" : "#/components/schemas/AuthenticationExtensionsClientInputsRegistrationExtensionClientInput" } } }, "PublicKeyCredentialDescriptor" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "id" : { "type" : "string", "format" : "byte" }, "transports" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "PublicKeyCredentialParameters" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "alg" : { "type" : "integer", "format" : "int64" } } }, "PublicKeyCredentialRpEntity" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "PublicKeyCredentialUserEntity" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "byte" }, "name" : { "type" : "string" }, "displayName" : { "type" : "string" } } }, "AuthenticationResponseJSON" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "rawId" : { "type" : "string" }, "type" : { "type" : "string" }, "response" : { "$ref" : "#/components/schemas/Response" } } }, "WebAuthnAuthenticationRequest" : { "type" : "object", "properties" : { "token" : { "type" : "string" }, "authenticationResponseJSON" : { "$ref" : "#/components/schemas/AuthenticationResponseJSON" } } }, "AuthenticationExtensionsClientInputsAuthenticationExtensionClientInput" : { "type" : "object", "properties" : { "appid" : { "type" : "string" }, "appidExclude" : { "type" : "string" }, "uvm" : { "type" : "boolean" }, "credProps" : { "type" : "boolean" }, "credentialProtectionPolicy" : { "type" : "string", "enum" : [ "userVerificationOptional", "userVerificationOptionalWithCredentialIDList", "userVerificationRequired" ] }, "enforceCredentialProtectionPolicy" : { "type" : "boolean" }, "hmacCreateSecret" : { "type" : "boolean" }, "hmacGetSecret" : { "$ref" : "#/components/schemas/HMACGetSecretInput" } } }, "PublicKeyCredentialRequestOptions" : { "type" : "object", "properties" : { "challenge" : { "$ref" : "#/components/schemas/Challenge" }, "timeout" : { "type" : "integer", "format" : "int64" }, "rpId" : { "type" : "string" }, "allowCredentials" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PublicKeyCredentialDescriptor" } }, "userVerification" : { "type" : "string" }, "hints" : { "type" : "array", "items" : { "type" : "string" } }, "extensions" : { "$ref" : "#/components/schemas/AuthenticationExtensionsClientInputsAuthenticationExtensionClientInput" } } }, "TicketAddressInfo" : { "type" : "object", "properties" : { "address" : { "type" : "string" }, "state" : { "type" : "string" }, "city" : { "type" : "string" }, "county" : { "type" : "string" } } }, "DigCheckInfo" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "companyName" : { "type" : "string" }, "title" : { "type" : "string" }, "subject" : { "type" : "string" }, "address" : { "type" : "string" }, "email" : { "type" : "string" }, "phone" : { "type" : "string" }, "message" : { "type" : "string" } } }, "SlackMessage" : { "type" : "object", "properties" : { "channel" : { "type" : "string" }, "username" : { "type" : "string" }, "icon_emoji" : { "type" : "string" }, "text" : { "type" : "string" }, "attachments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SlackMessageAttachment" } } } }, "SlackMessageAttachment" : { "type" : "object", "properties" : { "color" : { "type" : "string" }, "title" : { "type" : "string" }, "text" : { "type" : "string" } } }, "WebhookResponse" : { "type" : "object", "properties" : { "code" : { "type" : "integer", "format" : "int32" }, "message" : { "type" : "string" }, "body" : { "type" : "string" } } }, "UploadResponse" : { "type" : "object", "properties" : { "fileName" : { "type" : "string" }, "status" : { "type" : "string" }, "description" : { "type" : "string" } } }, "JobInfo" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "group" : { "type" : "string" } } }, "SchedulerInfo" : { "type" : "object", "properties" : { "cron_expression" : { "type" : "string" }, "time_zone" : { "type" : "string" }, "repeat_time" : { "type" : "integer", "format" : "int32" }, "start_date" : { "type" : "string" }, "end_date" : { "type" : "string" }, "employeeId" : { "type" : "integer", "format" : "int32" } } }, "AssetsHistoryRequest" : { "type" : "object", "properties" : { "assetSerials" : { "type" : "array", "items" : { "type" : "string" } }, "assetIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } }, "RenewalRequest" : { "type" : "object", "properties" : { "token" : { "type" : "string" } } }, "FeedbackRequest" : { "type" : "object", "properties" : { "requestId" : { "type" : "string" }, "verdict" : { "type" : "string" }, "note" : { "type" : "string" } } }, "FeedbackRecord" : { "type" : "object", "properties" : { "requestId" : { "type" : "string" }, "verdict" : { "type" : "string", "enum" : [ "CORRECT", "INCORRECT", "UNCLEAR" ] }, "note" : { "type" : "string" }, "userId" : { "type" : "string" }, "createdAt" : { "type" : "string", "format" : "date-time" }, "updatedAt" : { "type" : "string", "format" : "date-time" } } }, "AskRequest" : { "type" : "object", "properties" : { "question" : { "type" : "string" }, "binder" : { "type" : "string" } } }, "Answer" : { "type" : "object", "properties" : { "requestId" : { "type" : "string" }, "userId" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ANSWERED", "NOT_COVERED" ] }, "question" : { "type" : "string" }, "binder" : { "type" : "string" }, "text" : { "type" : "string" }, "citations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ResolvedCitation" } }, "escalation" : { "$ref" : "#/components/schemas/Escalation" }, "telemetry" : { "$ref" : "#/components/schemas/Telemetry" }, "truncatedAt" : { "type" : "integer", "format" : "int32" } } }, "Escalation" : { "type" : "object", "properties" : { "reason" : { "type" : "string", "enum" : [ "NOTHING_RETRIEVED", "MODEL_REFUSED", "NO_CITATIONS", "CITATION_UNRESOLVABLE" ] }, "detail" : { "type" : "string" }, "closestTopic" : { "type" : "string" }, "contact" : { "type" : "string" } } }, "ResolvedCitation" : { "type" : "object", "properties" : { "pageId" : { "type" : "integer", "format" : "int64" }, "documentId" : { "type" : "integer", "format" : "int64" }, "documentTitle" : { "type" : "string" }, "binder" : { "type" : "string" }, "pageNumber" : { "type" : "integer", "format" : "int32" }, "quotedText" : { "type" : "string" }, "pageStart" : { "type" : "integer", "format" : "int32" }, "pageEnd" : { "type" : "integer", "format" : "int32" }, "imageKey" : { "type" : "string" }, "crossesPages" : { "type" : "boolean" }, "answerStart" : { "type" : "integer", "format" : "int32" }, "answerEnd" : { "type" : "integer", "format" : "int32" }, "sectionHeading" : { "type" : "string" }, "imageUrl" : { "type" : "string" } } }, "Telemetry" : { "type" : "object", "properties" : { "model" : { "type" : "string" }, "promptVersion" : { "type" : "string" }, "corpusVersion" : { "type" : "integer", "format" : "int32" }, "pagesRead" : { "type" : "integer", "format" : "int32" }, "citationCount" : { "type" : "integer", "format" : "int32" }, "inputTokens" : { "type" : "integer", "format" : "int64" }, "outputTokens" : { "type" : "integer", "format" : "int64" }, "cacheReadTokens" : { "type" : "integer", "format" : "int64" }, "cacheCreationTokens" : { "type" : "integer", "format" : "int64" }, "attempts" : { "type" : "integer", "format" : "int32" }, "latencyMillis" : { "type" : "integer", "format" : "int64" }, "costUsd" : { "type" : "number" }, "answeredAt" : { "type" : "string", "format" : "date-time" } } }, "EmployeeMessageRequest" : { "type" : "object", "properties" : { "messageId" : { "type" : "integer", "format" : "int64" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "schedulerInfo" : { "$ref" : "#/components/schemas/SchedulerInfo" }, "employeeIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int64" } } } }, "AsyncTaskExecutor" : { "type" : "object" }, "BeanFactory" : { "type" : "object" }, "WebAsyncTaskEmployeeMessageResponseList" : { "type" : "object", "properties" : { "callable" : { "type" : "object" }, "timeout" : { "type" : "integer", "format" : "int64" }, "executor" : { "$ref" : "#/components/schemas/AsyncTaskExecutor" }, "beanFactory" : { "$ref" : "#/components/schemas/BeanFactory" } } }, "JsonNode" : { "type" : "object" }, "EmployeeMessageResponse" : { "type" : "object", "properties" : { "employeeId" : { "type" : "integer", "format" : "int64" }, "statusId" : { "type" : "integer", "format" : "int64" }, "messageUid" : { "type" : "string" }, "sentAt" : { "type" : "string", "format" : "date-time" }, "description" : { "type" : "string" } } }, "EmployeeMessageResponseList" : { "type" : "object", "properties" : { "total" : { "type" : "integer", "format" : "int32" }, "failures" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EmployeeMessageResponse" } }, "queued" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EmployeeMessageResponse" } } } }, "ImpersonationRequest" : { "type" : "object", "properties" : { "username" : { "type" : "string" }, "employeeId" : { "type" : "integer", "format" : "int64" } } }, "CheckRequest" : { "type" : "object", "properties" : { "text" : { "type" : "string" } } }, "UserAccessRequest" : { "type" : "object", "properties" : { "cp_user_id" : { "type" : "integer", "format" : "int64" }, "cp_user_name" : { "type" : "string" }, "last_updated_by" : { "type" : "string" }, "customer_account_id" : { "type" : "integer", "format" : "int64" }, "customer_contract_id" : { "type" : "integer", "format" : "int64" }, "customer_states" : { "type" : "string" }, "customer_account_number" : { "type" : "string" }, "customer_contract_number" : { "type" : "string" } } }, "WsvLocRequest" : { "type" : "object", "properties" : { "accountNumbers" : { "type" : "array", "items" : { "type" : "string" } }, "contractNumbers" : { "type" : "array", "items" : { "type" : "string" } }, "startDate" : { "type" : "string", "format" : "date-time" }, "endDate" : { "type" : "string", "format" : "date-time" }, "groupBy" : { "type" : "string" }, "ticketBucket" : { "type" : "string" } } }, "CPManagedServicesUser" : { "type" : "object", "properties" : { "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "email" : { "type" : "string" }, "accountName" : { "type" : "string" }, "projectId" : { "type" : "string" }, "projectName" : { "type" : "string" }, "state" : { "type" : "string" } } }, "CustomerPortalUser" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "email" : { "type" : "string" }, "state" : { "type" : "string" }, "company" : { "type" : "string" } } }, "GpsData" : { "type" : "object", "properties" : { "startDate" : { "type" : "string", "format" : "date-time" }, "endDate" : { "type" : "string", "format" : "date-time" }, "state" : { "type" : "string" } } }, "CreateDamageRequest" : { "type" : "object", "properties" : { "damageDateTime" : { "type" : "string", "format" : "date-time" }, "district" : { "type" : "integer", "format" : "int32" }, "addressLine1" : { "type" : "string" }, "addressLine2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "zipCode" : { "type" : "string" }, "notes" : { "type" : "string" }, "notifiedBy" : { "type" : "string" }, "notifyType" : { "type" : "integer", "format" : "int32" }, "callDateTime" : { "type" : "string", "format" : "date-time" }, "callerCompany" : { "type" : "string" }, "callerContactInfo" : { "type" : "string" }, "peoplesoftId" : { "type" : "integer", "format" : "int64" }, "pagedDateTime" : { "type" : "string", "format" : "date-time" }, "dispatcher" : { "type" : "integer", "format" : "int32" }, "origLocRequestNo" : { "type" : "string" }, "oneCallDamageRequestNo" : { "type" : "string" }, "damagingExcavator" : { "type" : "string" }, "customerAffected" : { "type" : "string" }, "facilityType" : { "type" : "integer", "format" : "int32" }, "callerStatement" : { "type" : "string" }, "customerRep" : { "type" : "string" }, "notifiedDateTime" : { "type" : "string", "format" : "date-time" }, "cdiConfirmation" : { "type" : "string" }, "confirmatonDateTime" : { "type" : "string", "format" : "date-time" }, "source" : { "type" : "string" }, "lat" : { "type" : "number", "format" : "double" }, "lon" : { "type" : "number", "format" : "double" }, "supervisorId" : { "type" : "integer", "format" : "int64" }, "origLocticketid" : { "type" : "integer", "format" : "int32" }, "origLocticketstartdate" : { "type" : "string", "format" : "date-time" }, "origLocticketenddate" : { "type" : "string", "format" : "date-time" }, "origlocexcavator" : { "type" : "string" }, "origloclocatorfirstname" : { "type" : "string" }, "origloclocatorlastname" : { "type" : "string" }, "origloclocatorpeoplesoftid" : { "type" : "integer", "format" : "int64" }, "origloctickettype" : { "type" : "string" }, "origloctypeofwork" : { "type" : "string" }, "origlocboring" : { "type" : "boolean" }, "dots_number" : { "type" : "string" }, "customer_claim_number" : { "type" : "string" }, "customer_claim_number2" : { "type" : "string" }, "crossstreet1" : { "type" : "string" }, "crossstreet2" : { "type" : "string" }, "oneCallDamageRequestticketId" : { "type" : "integer", "format" : "int32" }, "county" : { "type" : "string" }, "createdDateTime" : { "type" : "string", "format" : "date-time" }, "dmgNotificationMethod" : { "type" : "string" }, "supgroup" : { "type" : "string" }, "supgroupCode" : { "type" : "string" }, "supgroupTktproId" : { "type" : "integer", "format" : "int32" }, "managedServicesFlag" : { "type" : "boolean" }, "fieldInvestigator" : { "type" : "integer", "format" : "int64" } } }, "AuthenticationRequest" : { "type" : "object", "properties" : { "username" : { "type" : "string" }, "password" : { "type" : "string" } } }, "AddressForVerizon" : { "type" : "object", "properties" : { "addressType" : { "type" : "string" }, "firstName" : { "type" : "string" }, "middleName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "addressLine1" : { "type" : "string" }, "addressLine2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "zipCode" : { "type" : "string" }, "zipPlus4" : { "type" : "string" }, "country" : { "type" : "string" }, "attn" : { "type" : "string" }, "cbrNumber" : { "type" : "string" }, "title" : { "type" : "string" }, "suffix" : { "type" : "string" } } }, "NameForVerizon" : { "type" : "object", "properties" : { "lastName" : { "type" : "string" }, "firstName" : { "type" : "string" }, "prefix" : { "type" : "string" }, "middleInitial" : { "type" : "string" }, "suffixName" : { "type" : "string" }, "courtesyTitleCode" : { "type" : "string" }, "businessName" : { "type" : "string" }, "alternateBusinessName" : { "type" : "string" }, "businessTitle" : { "type" : "string" }, "titleName" : { "type" : "string" } } }, "VerizonAccessory" : { "type" : "object", "properties" : { "accessorySku" : { "type" : "string" }, "quantity" : { "type" : "string" }, "price" : { "type" : "string" } } }, "VerizonFeature" : { "type" : "object", "properties" : { "featureId" : { "type" : "string" }, "addDropIndicator" : { "type" : "string" } } }, "VerizonLineDetails" : { "type" : "object", "properties" : { "lineSeqNo" : { "type" : "string" }, "lineActionType" : { "type" : "string" }, "npaNxx" : { "type" : "string" }, "oldPricePlanId" : { "type" : "string" }, "pricePlanId" : { "type" : "string" }, "productBundleId" : { "type" : "string" }, "oldDeviceEsn" : { "type" : "string" }, "sku" : { "type" : "string" }, "preOrder" : { "type" : "string" }, "deviceEsn" : { "type" : "string" }, "iccId" : { "type" : "string" }, "globalSimId" : { "type" : "string" }, "isCpeSim" : { "type" : "string" }, "m2MOverTheWire" : { "type" : "string" }, "global" : { "type" : "string" }, "requireGlobalSvc" : { "type" : "string" }, "useEtfWaiver" : { "type" : "string" }, "featureCount" : { "type" : "string" }, "featureList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VerizonFeature" } }, "productOffersCount" : { "type" : "string" }, "productCorrelationId" : { "type" : "string" }, "productOfferList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VerizonProductOffer" } }, "accessoriesList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VerizonAccessory" } }, "promotionsList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VerizonPromotion" } }, "staticIP" : { "type" : "string" }, "ehaPoolGroup" : { "type" : "string" }, "portinMtn" : { "type" : "string" }, "subAccountNum" : { "type" : "string" }, "mobileNum" : { "type" : "string" }, "newMobileNum" : { "type" : "string" }, "upgradeEligibleMobileNum" : { "type" : "string" }, "effectiveDate" : { "type" : "string" }, "contractTerm" : { "type" : "string" }, "suspendWithBillingIndicator" : { "type" : "string" }, "rsnCode" : { "type" : "string" }, "puiName" : { "type" : "string" }, "costCenterCode" : { "type" : "string" }, "customerUserId" : { "type" : "string" }, "bizId" : { "type" : "string" }, "email" : { "type" : "string" }, "name" : { "$ref" : "#/components/schemas/NameForVerizon" }, "shipmentInfo" : { "$ref" : "#/components/schemas/AddressForVerizon" }, "puiInfo" : { "$ref" : "#/components/schemas/AddressForVerizon" }, "lineType" : { "type" : "string" }, "remarkText" : { "type" : "string" }, "errorMsg" : { "type" : "string" }, "hpServiceType" : { "type" : "string" }, "simSku" : { "type" : "string" }, "hpExcelLineAddressInfo" : { "type" : "string" }, "hpExcelRequestType" : { "type" : "string" }, "hpExcelPlanOptions" : { "type" : "string" }, "wfmOrderType" : { "type" : "string" }, "addlItemList" : { "type" : "string" }, "targetEcpdId" : { "type" : "string" }, "targetAccountNum" : { "type" : "string" }, "targetSubAccountNum" : { "type" : "string" }, "middleInitial" : { "type" : "string" }, "purchaseOrderNumber" : { "type" : "string" }, "purchaseOrderType" : { "type" : "string" }, "payInfo" : { "type" : "string" }, "hotlineMobileNum" : { "type" : "string" }, "nonGeoDeviceInd" : { "type" : "string" }, "nonGeoNumberRequiredInd" : { "type" : "string" }, "servicePO" : { "type" : "string" }, "equipmentPO" : { "type" : "string" }, "businessId" : { "type" : "string" }, "locationCode" : { "type" : "string" }, "aceOrderNumber" : { "type" : "string" }, "mtnBlockList" : { "type" : "string" }, "callForwardingType" : { "type" : "string" }, "callForwardToNumber" : { "type" : "string" }, "salesRepID" : { "type" : "string" }, "shipSKU" : { "type" : "string" } } }, "VerizonOrderInfoRequest" : { "type" : "object", "properties" : { "ospAccount" : { "type" : "string" }, "portInPasscode" : { "type" : "string" }, "portInName" : { "type" : "string" }, "portInAddress" : { "type" : "string" }, "portInContact" : { "type" : "string" }, "serviceZipCode" : { "type" : "string" }, "parentID" : { "type" : "string" }, "uniqueOrderType" : { "type" : "string" }, "scheduleDate" : { "type" : "string" }, "effectiveDate" : { "type" : "string" }, "reasonCode" : { "type" : "string" }, "shipmentInfo" : { "$ref" : "#/components/schemas/AddressForVerizon" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "autoAssign" : { "type" : "string" }, "salesRepID" : { "type" : "string" }, "shipSKU" : { "type" : "string" }, "dropAccessory" : { "type" : "string" }, "bulkHeaderId" : { "type" : "string" }, "locationCode" : { "type" : "string" }, "transactionType" : { "type" : "string" }, "paymentType" : { "type" : "string" }, "vipOrderNum" : { "type" : "string" }, "spocs" : { "type" : "string" }, "listLineDetails" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VerizonLineDetails" } } } }, "VerizonProductOffer" : { "type" : "object", "properties" : { "productId" : { "type" : "string" }, "addDropIndicator" : { "type" : "string" } } }, "VerizonPromotion" : { "type" : "object", "properties" : { "promotionId" : { "type" : "string" }, "addDropIndicator" : { "type" : "string" } } }, "JAXBElementString" : { "type" : "object", "properties" : { "name" : { "type" : "object", "properties" : { "namespaceURI" : { "type" : "string" }, "localPart" : { "type" : "string" }, "prefix" : { "type" : "string" } } }, "value" : { "type" : "string" }, "nil" : { "type" : "boolean" }, "typeSubstituted" : { "type" : "boolean" }, "globalScope" : { "type" : "boolean" } } }, "VerizonStatusResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "statusResponse" : { "$ref" : "#/components/schemas/Response" } } }, "VerizonLookupRequest" : { "type" : "object", "properties" : { "action" : { "type" : "string" }, "subActionType" : { "type" : "string" }, "mtnCount" : { "type" : "string" }, "retrieveEarlyTerminationFee" : { "type" : "string" }, "mtnList" : { "type" : "array", "items" : { "type" : "string" } }, "zipCode" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "npaNxx" : { "type" : "string" }, "exceptionPlanOnly" : { "type" : "string" }, "accessFeeRange" : { "type" : "string" }, "contractRange" : { "type" : "string" }, "planType" : { "type" : "string" }, "deviceSku" : { "type" : "string" }, "esnMeid" : { "type" : "string" }, "selectedNpaNxx" : { "type" : "string" }, "mobileNumber" : { "type" : "string" }, "primaryPricePlanId" : { "type" : "string" }, "pricePlanId" : { "type" : "string" }, "contractTerm" : { "type" : "string" }, "iccId" : { "type" : "string" }, "deviceBrand" : { "type" : "string" }, "accType" : { "type" : "string" }, "deviceId" : { "type" : "string" }, "simId" : { "type" : "string" }, "deviceIdCount" : { "type" : "string" }, "deviceIdList" : { "type" : "array", "items" : { "type" : "string" } }, "mtn" : { "type" : "string" }, "billingDate" : { "type" : "string" }, "billingDate2" : { "type" : "string" }, "billingDate3" : { "type" : "string" }, "etfType" : { "type" : "string" }, "mdnList" : { "type" : "array", "items" : { "type" : "string" } }, "address" : { "$ref" : "#/components/schemas/AddressForVerizon" }, "checkOnNetInd" : { "type" : "string" }, "refNum" : { "type" : "string" }, "subAccountNumber" : { "type" : "string" }, "token" : { "type" : "string" }, "retryLineSeqNo" : { "type" : "array", "items" : { "type" : "string" } }, "transactionId" : { "type" : "string" } } }, "VerizonResponse" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "description" : { "type" : "string" }, "result" : { "type" : "object" } } }, "PumpDeviceUpsertRequest" : { "type" : "object", "properties" : { "pump_devices_id" : { "type" : "integer", "format" : "int64" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "pump_date" : { "type" : "string", "format" : "date-time" }, "safety_screen_triggers_24" : { "type" : "integer", "format" : "int32" }, "safety_screen_version" : { "type" : "string" }, "model" : { "type" : "string" }, "host_name" : { "type" : "string" }, "os_name" : { "type" : "string" }, "os_version" : { "type" : "string" }, "serial_number" : { "type" : "string" }, "ip_address" : { "type" : "string" }, "free_space" : { "type" : "string" }, "memory" : { "type" : "string" }, "mobile_number" : { "type" : "integer", "format" : "int64" }, "imei" : { "type" : "integer", "format" : "int64" }, "imed" : { "type" : "string" }, "available_gps_ports" : { "type" : "string" }, "last_gps_lock" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" } } }, "UsicWirelessSchedulerInfo" : { "type" : "object", "properties" : { "cron_expression" : { "type" : "string" }, "time_zone" : { "type" : "string" }, "repeat_time" : { "type" : "integer", "format" : "int32" }, "start_date" : { "type" : "string" }, "end_date" : { "type" : "string" }, "reportType" : { "type" : "string" } } }, "Accrual" : { "type" : "object", "properties" : { "accrual_id" : { "type" : "integer", "format" : "int64" }, "period_id" : { "type" : "integer", "format" : "int64" }, "amount" : { "type" : "number", "format" : "double" }, "accrual_source" : { "type" : "string" }, "accrual_source_id1" : { "type" : "integer", "format" : "int32" }, "accrual_source_id2" : { "type" : "integer", "format" : "int32" }, "accrual_source_id3" : { "type" : "integer", "format" : "int32" }, "district_id" : { "type" : "integer", "format" : "int64" }, "remarks" : { "type" : "string" }, "attributes1" : { "type" : "string" }, "attributes2" : { "type" : "string" }, "attributes3" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "request_id" : { "type" : "integer", "format" : "int64" }, "accrual_type" : { "type" : "string" }, "variance_amount" : { "type" : "number", "format" : "double" }, "retain_balance" : { "type" : "boolean" }, "source_accrual_balance" : { "type" : "number", "format" : "double" }, "cmsRequest" : { "$ref" : "#/components/schemas/CmsRequest" }, "financialPeriod" : { "$ref" : "#/components/schemas/FinancialPeriod" }, "district" : { "$ref" : "#/components/schemas/District" } } }, "AccrualSummary" : { "type" : "object", "properties" : { "accrual_summary_id" : { "type" : "integer", "format" : "int64" }, "period_id" : { "type" : "integer", "format" : "int64" }, "request_id" : { "type" : "integer", "format" : "int64" }, "district_id" : { "type" : "integer", "format" : "int64" }, "accrual_type" : { "type" : "string" }, "beginning_balance" : { "type" : "number", "format" : "double" }, "ending_balance" : { "type" : "number", "format" : "double" }, "period_amount" : { "type" : "number", "format" : "double" }, "attributes1" : { "type" : "string" }, "attributes2" : { "type" : "string" }, "attributes3" : { "type" : "string" }, "current_flag" : { "type" : "boolean" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string", "writeOnly" : true }, "financialPeriod" : { "$ref" : "#/components/schemas/FinancialPeriod" }, "cmsRequest" : { "$ref" : "#/components/schemas/CmsRequest" }, "district" : { "$ref" : "#/components/schemas/District" } } }, "Announcement" : { "type" : "object", "properties" : { "announcement_id" : { "type" : "integer", "format" : "int64" }, "announcement_text" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "high_priority" : { "type" : "boolean" }, "employee" : { "$ref" : "#/components/schemas/Employee" } } }, "Application" : { "type" : "object", "properties" : { "application_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "url" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "attachmentEntities" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AttachmentEntity" } }, "storageVolumes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/StorageVolume" } }, "userDataAccesses" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/UserDataAccesses" } } } }, "Asset" : { "type" : "object", "properties" : { "asset_key" : { "$ref" : "#/components/schemas/AssetPK" }, "asset_id" : { "type" : "integer", "format" : "int64" }, "version_number" : { "type" : "integer", "format" : "int32" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "description" : { "type" : "string" }, "purchase_date" : { "type" : "string", "format" : "date-time" }, "purchase_price" : { "type" : "number", "format" : "double" }, "tax" : { "type" : "number", "format" : "double" }, "warranty" : { "type" : "boolean" }, "warranty_start_date" : { "type" : "string", "format" : "date-time" }, "warranty_end_date" : { "type" : "string", "format" : "date-time" }, "deletion_reason_id" : { "type" : "integer", "format" : "int64" }, "model_id" : { "type" : "integer", "format" : "int64" }, "serial_number" : { "type" : "string" }, "usic_tag" : { "type" : "string" }, "status_id" : { "type" : "integer", "format" : "int64" }, "district_id" : { "type" : "integer", "format" : "int64" }, "active" : { "type" : "boolean" }, "source_system" : { "type" : "string" }, "search_text" : { "type" : "string" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "mapping_id" : { "type" : "integer", "format" : "int64" }, "location_id" : { "type" : "integer", "format" : "int64" }, "in_transfer" : { "type" : "boolean" }, "accepted_by_id" : { "type" : "integer", "format" : "int64" }, "supgroup_code" : { "type" : "string" }, "book_value" : { "type" : "number", "format" : "double" }, "organization_id" : { "type" : "integer", "format" : "int64" }, "workday_id" : { "type" : "string" }, "tracking_no" : { "type" : "string" }, "police_report_number" : { "type" : "string" }, "repair_reason_id" : { "type" : "integer", "format" : "int64" }, "loss_address" : { "type" : "string" }, "loss_description" : { "type" : "string" }, "loss_date" : { "type" : "string", "format" : "date-time" }, "original_creation_date" : { "type" : "string", "format" : "date-time" }, "reference_id" : { "type" : "string" }, "dist" : { "$ref" : "#/components/schemas/District" }, "deletionType" : { "$ref" : "#/components/schemas/DeletionType" }, "repairReason" : { "$ref" : "#/components/schemas/RepairReason" }, "locatorCheckins" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LocatorCheckin" } }, "assetModel" : { "$ref" : "#/components/schemas/AssetModel" }, "assetStatus" : { "$ref" : "#/components/schemas/AssetStatus" }, "categoryTypeMakeMapping" : { "$ref" : "#/components/schemas/CategoryTypeMakeMapping" }, "employeeAcceptedBy" : { "$ref" : "#/components/schemas/Employee" }, "assetAssignment" : { "$ref" : "#/components/schemas/AssetAssignment" }, "lastAssignment" : { "$ref" : "#/components/schemas/AssetAssignment" }, "location" : { "$ref" : "#/components/schemas/Location" }, "assetAttributeValues" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetAttributeValue" } }, "netmotionDevices" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/NetmotionDevice" } }, "supgroup" : { "$ref" : "#/components/schemas/SupervisorGroup" } } }, "AssetAssignment" : { "type" : "object", "properties" : { "assignment_id" : { "type" : "integer", "format" : "int64" }, "asset_id" : { "type" : "integer", "format" : "int64" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "active" : { "type" : "boolean" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "assigned_by" : { "type" : "integer", "format" : "int64" }, "assigned_on" : { "type" : "string", "format" : "date-time" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "primary_flag" : { "type" : "boolean" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "employeesActiveNoAsset" : { "$ref" : "#/components/schemas/EmployeesActiveNoAsset" }, "employeesActiveMultipleItAssets" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssets" }, "assignedByEmployee" : { "$ref" : "#/components/schemas/Employee" }, "employeeOnLoan" : { "$ref" : "#/components/schemas/EmployeeOnLoan" }, "asset" : { "$ref" : "#/components/schemas/Asset" } } }, "AssetAttribute" : { "type" : "object", "properties" : { "attribute_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "label" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "data_type" : { "type" : "string" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "required_field" : { "type" : "boolean" }, "assetAttributeValues" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetAttributeValue" } }, "attributeMappings" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AttributeMapping" } } } }, "AssetAttributeValue" : { "type" : "object", "properties" : { "attribute_value_id" : { "type" : "integer", "format" : "int64" }, "asset_id" : { "type" : "integer", "format" : "int64" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "active" : { "type" : "boolean" }, "record_description" : { "type" : "string" }, "update_process" : { "type" : "string" }, "attribute_id" : { "type" : "integer", "format" : "int64" }, "value" : { "type" : "string" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "assetAttribute" : { "$ref" : "#/components/schemas/AssetAttribute" } } }, "AssetCategory" : { "type" : "object", "properties" : { "category_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "categoryTypeMakeMappings" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMapping" } } } }, "AssetCategoryType" : { "type" : "object", "properties" : { "category_type_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "categoryTypeMakeMappings" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMapping" } } } }, "AssetMake" : { "type" : "object", "properties" : { "make_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "attributeMappings" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AttributeMapping" } }, "assetModels" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetModel" } }, "categoryTypeMakeMappings" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMapping" } } } }, "AssetModel" : { "type" : "object", "properties" : { "model_id" : { "type" : "integer", "format" : "int64" }, "make_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "assets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } }, "assetMake" : { "$ref" : "#/components/schemas/AssetMake" } } }, "AssetPK" : { "type" : "object", "properties" : { "asset_id" : { "type" : "integer", "format" : "int64" }, "version_number" : { "type" : "integer", "format" : "int64" } } }, "AssetStatus" : { "type" : "object", "properties" : { "status_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "assets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } } } }, "AssetType" : { "type" : "object", "properties" : { "type_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "attributeMappings" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AttributeMapping" } }, "categoryTypeMakeMappings" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryTypeMakeMapping" } } } }, "Attachment" : { "type" : "object", "properties" : { "attachment_id" : { "type" : "integer", "format" : "int64" }, "volume_id" : { "type" : "integer", "format" : "int64" }, "priv" : { "type" : "boolean" }, "path" : { "type" : "string" }, "filename" : { "type" : "string" }, "filetype" : { "type" : "string" }, "filesize" : { "type" : "string" }, "attachment_entity_id" : { "type" : "integer", "format" : "int64" }, "pk1_int" : { "type" : "integer", "format" : "int64" }, "pk2_int" : { "type" : "integer", "format" : "int64" }, "pk3_int" : { "type" : "integer", "format" : "int64" }, "pk1_var" : { "type" : "string" }, "pk2_var" : { "type" : "string" }, "pk3_var" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "storageVolume" : { "$ref" : "#/components/schemas/StorageVolume" }, "attachmentEntity" : { "$ref" : "#/components/schemas/AttachmentEntity" } } }, "AttachmentEntities" : { "type" : "object", "properties" : { "attachment_entity_id" : { "type" : "integer", "format" : "int64" }, "attachment_entity_name" : { "type" : "string" }, "entity_table" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" } } }, "AttachmentEntity" : { "type" : "object", "properties" : { "attachment_entity_id" : { "type" : "integer", "format" : "int64" }, "application_id" : { "type" : "integer", "format" : "int64" }, "attachment_entity_name" : { "type" : "string" }, "entity_table" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "application" : { "$ref" : "#/components/schemas/Application" }, "attachments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Attachment" } } } }, "AttributeMapping" : { "type" : "object", "properties" : { "mapping_id" : { "type" : "integer", "format" : "int64" }, "attribute_id" : { "type" : "integer", "format" : "int64" }, "asset_type_id" : { "type" : "integer", "format" : "int64" }, "model_id" : { "type" : "integer", "format" : "int64" }, "make_id" : { "type" : "integer", "format" : "int64" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "quick_code_id" : { "type" : "integer", "format" : "int64" }, "assetAttribute" : { "$ref" : "#/components/schemas/AssetAttribute" }, "assetType" : { "$ref" : "#/components/schemas/AssetType" }, "assetModel" : { "$ref" : "#/components/schemas/AssetModel" }, "assetMake" : { "$ref" : "#/components/schemas/AssetMake" }, "quickCode" : { "$ref" : "#/components/schemas/QuickCode" } } }, "BillableCustomer" : { "type" : "object", "properties" : { "billable_customers_id" : { "type" : "integer", "format" : "int64" }, "billable_customers_group_id" : { "type" : "integer", "format" : "int64" }, "customer_id" : { "type" : "integer", "format" : "int64" }, "contract_id" : { "type" : "string" }, "state_id" : { "type" : "integer", "format" : "int64" }, "utility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_id" : { "type" : "integer", "format" : "int64" }, "notified_by_category_id" : { "type" : "integer", "format" : "int64" }, "not_billable" : { "type" : "boolean" }, "inv_photos_required" : { "type" : "integer", "format" : "int32" }, "days_to_send_report" : { "type" : "integer", "format" : "int32" }, "active" : { "type" : "boolean" }, "start_date" : { "type" : "string", "format" : "date-time" }, "end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "last_updated_by_id" : { "type" : "integer", "format" : "int64" }, "cmsCustomer" : { "$ref" : "#/components/schemas/CMSCustomer" }, "facility" : { "$ref" : "#/components/schemas/Facility" }, "lastUpdatedBy" : { "$ref" : "#/components/schemas/Employee" }, "createdBy" : { "$ref" : "#/components/schemas/Employee" }, "state" : { "$ref" : "#/components/schemas/State" } } }, "CMSCustomer" : { "type" : "object", "properties" : { "customer_id" : { "type" : "integer", "format" : "int64" }, "account_level_customer_id" : { "type" : "integer", "format" : "int64" }, "account_level_customer" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "eff_start_date" : { "type" : "string", "format" : "date-time" }, "eff_end_date" : { "type" : "string", "format" : "date-time" }, "active" : { "type" : "boolean" }, "damageCustomers" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/DamageCustomer" } }, "claimPayees" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimPayee" } }, "flatRateCustomers" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/FlatRateCustomer" } }, "billableCustomers" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/BillableCustomer" } }, "investigationDetailsVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersion" } } } }, "CMSInvestigationDetail" : { "type" : "object", "properties" : { "detail_id" : { "type" : "integer", "format" : "int64" }, "investigation_id" : { "type" : "integer", "format" : "int64" }, "customer_id" : { "type" : "integer", "format" : "int64" }, "utility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_id" : { "type" : "integer", "format" : "int64" }, "locator_id" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "active" : { "type" : "boolean" }, "investigation_root_cause_id" : { "type" : "integer", "format" : "int64" }, "completed" : { "type" : "boolean" }, "completed_by" : { "type" : "integer", "format" : "int64" }, "completed_date" : { "type" : "string", "format" : "date-time" }, "search_text" : { "type" : "string" }, "att1" : { "type" : "string" }, "att2" : { "type" : "string" }, "att3" : { "type" : "string" }, "att4" : { "type" : "string" }, "att5" : { "type" : "string" }, "supgroup" : { "type" : "string" }, "supervisor_id" : { "type" : "integer", "format" : "int64" }, "event_summary" : { "type" : "string" }, "video_url" : { "type" : "string" }, "inv_report_attachment_id" : { "type" : "integer", "format" : "int64" }, "customer" : { "$ref" : "#/components/schemas/Customer" }, "investigation" : { "$ref" : "#/components/schemas/Investigation" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "estimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Estimate" } }, "investigationDetailLines" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationDetailLine" } }, "investigationReport" : { "$ref" : "#/components/schemas/DamagePhoto" }, "utilitiesProfilesView" : { "$ref" : "#/components/schemas/UtilitiesProfilesView" } } }, "CasesSubtype" : { "type" : "object", "properties" : { "cases_sub_type_id" : { "type" : "integer", "format" : "int64" }, "cases_type_id" : { "type" : "integer", "format" : "int64" }, "cases_sub_type_description" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "legalCases" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalCase" } }, "casesType" : { "$ref" : "#/components/schemas/CasesType" } } }, "CasesType" : { "type" : "object", "properties" : { "cases_type_id" : { "type" : "integer", "format" : "int64" }, "cases_type_description" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "legalCases" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalCase" } }, "casesSubtypes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/CasesSubtype" } } } }, "CategoryTypeMakeMapping" : { "type" : "object", "properties" : { "mapping_id" : { "type" : "integer", "format" : "int64" }, "category_id" : { "type" : "integer", "format" : "int64" }, "type_id" : { "type" : "integer", "format" : "int64" }, "make_id" : { "type" : "integer", "format" : "int64" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "category_type_id" : { "type" : "integer", "format" : "int64" }, "assetCategory" : { "$ref" : "#/components/schemas/AssetCategory" }, "assetType" : { "$ref" : "#/components/schemas/AssetType" }, "assetMake" : { "$ref" : "#/components/schemas/AssetMake" }, "assetCategoryType" : { "$ref" : "#/components/schemas/AssetCategoryType" }, "assets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } } } }, "Claim" : { "type" : "object", "properties" : { "claim_id" : { "type" : "integer", "format" : "int64" }, "customer_id" : { "type" : "integer", "format" : "int64" }, "claim_category_id" : { "type" : "integer", "format" : "int64" }, "invoice_number" : { "type" : "string" }, "invoice_date" : { "type" : "string", "format" : "date-time" }, "invoice_receipt_date" : { "type" : "string", "format" : "date-time" }, "payment_request_date" : { "type" : "string", "format" : "date-time" }, "invoice_amount" : { "type" : "number", "format" : "double" }, "payment_amount" : { "type" : "number", "format" : "double" }, "cost_center_id" : { "type" : "integer", "format" : "int64" }, "accrued" : { "type" : "boolean" }, "accrued_amount" : { "type" : "number", "format" : "double" }, "accrued_period_id" : { "type" : "integer", "format" : "int64" }, "request_id" : { "type" : "integer", "format" : "int64" }, "payment_mode_id" : { "type" : "integer", "format" : "int64" }, "disputed" : { "type" : "boolean" }, "dispute_reason_id" : { "type" : "integer", "format" : "int64" }, "period_id" : { "type" : "integer", "format" : "int64" }, "spend_category_id" : { "type" : "integer", "format" : "int64" }, "final_disposition_id" : { "type" : "integer", "format" : "int64" }, "status_id" : { "type" : "integer", "format" : "int64" }, "completed_by" : { "type" : "integer", "format" : "int64" }, "completed_date" : { "type" : "string", "format" : "date-time" }, "approved" : { "type" : "boolean" }, "approved_by" : { "type" : "integer", "format" : "int64" }, "approved_date" : { "type" : "string", "format" : "date-time" }, "att1_int" : { "type" : "integer", "format" : "int32" }, "att2_int" : { "type" : "integer", "format" : "int32" }, "att3_int" : { "type" : "integer", "format" : "int32" }, "att1_var" : { "type" : "string" }, "att2_var" : { "type" : "string" }, "att3_var" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "claim_payee_id" : { "type" : "integer", "format" : "int64" }, "claim_payee_address_id" : { "type" : "integer", "format" : "int64" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "search_text" : { "type" : "string" }, "reviewed_by" : { "type" : "integer", "format" : "int64" }, "review_date" : { "type" : "string", "format" : "date-time" }, "notes" : { "type" : "string" }, "paid" : { "type" : "boolean" }, "damage_id" : { "type" : "integer", "format" : "int64" }, "case_id" : { "type" : "integer", "format" : "int64" }, "docket_number" : { "type" : "string" }, "retain_reserve_balance" : { "type" : "boolean" }, "settlement_pay_amount" : { "type" : "number", "format" : "double" }, "should_cost_estimate" : { "type" : "number", "format" : "double" }, "wd_supplier_invoice_reference" : { "type" : "string" }, "should_cost_variance_id" : { "type" : "integer", "format" : "int64" }, "original_claim_id" : { "type" : "integer", "format" : "int64" }, "customer" : { "$ref" : "#/components/schemas/Customer" }, "claimCategory" : { "$ref" : "#/components/schemas/ClaimCategory" }, "damage" : { "$ref" : "#/components/schemas/Damage" }, "payeeAddress" : { "$ref" : "#/components/schemas/PayeeAddress" }, "claimSpendCategory" : { "$ref" : "#/components/schemas/ClaimSpendCategory" }, "financialPeriod" : { "$ref" : "#/components/schemas/FinancialPeriod" }, "claimDetails" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimDetail" } }, "claimDiscounts" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimDiscount" } } } }, "ClaimAllocationType" : { "type" : "object", "properties" : { "claim_allocation_type_id" : { "type" : "integer", "format" : "int64" }, "claim_category_id" : { "type" : "integer", "format" : "int64" }, "type_allocation_name" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "seq" : { "type" : "integer", "format" : "int32" }, "claimCategory" : { "$ref" : "#/components/schemas/ClaimCategory" } } }, "ClaimCategory" : { "type" : "object", "properties" : { "claim_category_id" : { "type" : "integer", "format" : "int64" }, "claim_category_name" : { "type" : "string" }, "claim_category_type" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "claims" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Claim" } }, "claimAllocationTypes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimAllocationType" } }, "claimSpendCategories" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimSpendCategory" } } } }, "ClaimDetail" : { "type" : "object", "properties" : { "claim_detail_id" : { "type" : "integer", "format" : "int64" }, "claim_id" : { "type" : "integer", "format" : "int64" }, "damage_id" : { "type" : "integer", "format" : "int64" }, "case_id" : { "type" : "integer", "format" : "int64" }, "payment_amount" : { "type" : "number", "format" : "double" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "facility_type_id" : { "type" : "integer", "format" : "int64" }, "utility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_id" : { "type" : "integer", "format" : "int64" }, "estimate_variance_reason_id" : { "type" : "integer", "format" : "int64" }, "retain_accrual_balance" : { "type" : "boolean" }, "investigation_detail_id" : { "type" : "integer", "format" : "int64" }, "estimate_id" : { "type" : "integer", "format" : "int64" }, "accrued" : { "type" : "boolean" }, "accrued_amount" : { "type" : "number", "format" : "double" }, "estimate_version_number" : { "type" : "integer", "format" : "int32" }, "estimate_accrued_balance" : { "type" : "number", "format" : "double" }, "estimate_accrued_amount" : { "type" : "number", "format" : "double" }, "claim" : { "$ref" : "#/components/schemas/Claim" }, "legalCase" : { "$ref" : "#/components/schemas/LegalCase" }, "damage" : { "$ref" : "#/components/schemas/Damage" }, "investigationDetail" : { "$ref" : "#/components/schemas/InvestigationDetail" } } }, "ClaimDiscount" : { "type" : "object", "properties" : { "claim_discount_id" : { "type" : "integer", "format" : "int64" }, "claim_id" : { "type" : "integer", "format" : "int64" }, "discount_reason" : { "type" : "integer", "format" : "int64" }, "discount_amount" : { "type" : "number", "format" : "double" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "claim" : { "$ref" : "#/components/schemas/Claim" } } }, "ClaimPayee" : { "type" : "object", "properties" : { "claim_payee_id" : { "type" : "integer", "format" : "int64" }, "customer_id" : { "type" : "integer", "format" : "int64" }, "first_name" : { "type" : "string" }, "last_name" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "start_date" : { "type" : "string", "format" : "date-time" }, "end_date" : { "type" : "string", "format" : "date-time" }, "cmsCustomer" : { "$ref" : "#/components/schemas/CMSCustomer" } } }, "ClaimSpendCategory" : { "type" : "object", "properties" : { "spend_category_id" : { "type" : "integer", "format" : "int64" }, "claim_category_id" : { "type" : "integer", "format" : "int64" }, "facility_damage_related" : { "type" : "boolean" }, "spend_category" : { "type" : "string" }, "wd_acct" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "include_pl_rp_paid" : { "type" : "boolean" }, "claimCategory" : { "$ref" : "#/components/schemas/ClaimCategory" }, "claims" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Claim" } } } }, "CmsRequest" : { "type" : "object", "properties" : { "request_id" : { "type" : "integer", "format" : "int64" }, "emp_id" : { "type" : "integer", "format" : "int64" }, "userid" : { "type" : "integer", "format" : "int64" }, "username" : { "type" : "string" }, "session_id" : { "type" : "integer", "format" : "int64" }, "start_time" : { "type" : "string", "format" : "date-time" }, "end_time" : { "type" : "string", "format" : "date-time" }, "request_name" : { "type" : "string" }, "request_type" : { "type" : "string" }, "completed_status" : { "type" : "string" }, "param1" : { "type" : "string" }, "param2" : { "type" : "string" }, "param3" : { "type" : "string" }, "param4" : { "type" : "string" }, "param5" : { "type" : "string" }, "param6" : { "type" : "string" }, "param7" : { "type" : "string" }, "param8" : { "type" : "string" }, "param9" : { "type" : "string" }, "param10" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "accrualSummaries" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AccrualSummary" } }, "accruals" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Accrual" } }, "legalRisks" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalRisk" } }, "policyDropOffEstimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimate" } } } }, "Comment" : { "type" : "object", "properties" : { "comment_id" : { "type" : "integer", "format" : "int64" }, "content" : { "type" : "string" }, "idea_id" : { "type" : "integer", "format" : "int64" }, "author_id" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "idea" : { "$ref" : "#/components/schemas/Idea" } } }, "Contract" : { "type" : "object", "properties" : { "contract_id" : { "type" : "string" }, "contract_name" : { "type" : "string" }, "status" : { "type" : "string" }, "customer_contract_number" : { "type" : "string" }, "usic_contract_number" : { "type" : "string" }, "account_name" : { "type" : "string" }, "account_number" : { "type" : "string" }, "contract_effective_date" : { "type" : "string", "format" : "date-time" }, "contract_expiration_date" : { "type" : "string", "format" : "date-time" }, "contract_stage" : { "type" : "string" }, "contract_type" : { "type" : "string" }, "primary_utility_type" : { "type" : "string" }, "utility_type" : { "type" : "string" }, "quote" : { "type" : "string" }, "usic_contract_type" : { "type" : "string" }, "damage_liability" : { "type" : "string" }, "master_contract_number" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "eff_start_date" : { "type" : "string", "format" : "date-time" }, "eff_end_date" : { "type" : "string", "format" : "date-time" }, "customer" : { "$ref" : "#/components/schemas/Customer" } } }, "Country" : { "type" : "object", "properties" : { "countryid" : { "type" : "integer", "format" : "int64" }, "country_code" : { "type" : "string" }, "country_name" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "locations" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Location" } }, "states" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/State" } } } }, "Customer" : { "type" : "object", "properties" : { "customer_id" : { "type" : "integer", "format" : "int64" }, "account_level_customer_id" : { "type" : "integer", "format" : "int64" }, "account_level_customer" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "eff_start_date" : { "type" : "string", "format" : "date-time" }, "eff_end_date" : { "type" : "string", "format" : "date-time" }, "contracts" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Contract" } } } }, "Damage" : { "type" : "object", "properties" : { "damage_id" : { "type" : "integer", "format" : "int64" }, "damage_reported_date" : { "type" : "string", "format" : "date-time" }, "damage_create_date" : { "type" : "string", "format" : "date-time" }, "damage_date_time" : { "type" : "string", "format" : "date-time" }, "dispatcher_id" : { "type" : "integer", "format" : "int64" }, "district_id" : { "type" : "integer", "format" : "int64" }, "excavator_id" : { "type" : "integer", "format" : "int64" }, "facility_type_id" : { "type" : "integer", "format" : "int64" }, "notified_category_id" : { "type" : "integer", "format" : "int64" }, "cdi_id" : { "type" : "integer", "format" : "int64" }, "one_call_request_num" : { "type" : "string" }, "notified_by_name" : { "type" : "string" }, "add_1" : { "type" : "string" }, "add_2" : { "type" : "string" }, "city" : { "type" : "string" }, "zip" : { "type" : "string" }, "cross_str1" : { "type" : "string" }, "ticket_id" : { "type" : "integer", "format" : "int64" }, "ticket_number" : { "type" : "string" }, "caller_stmt_call_notes" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "damage_number" : { "type" : "string" }, "stateid" : { "type" : "integer", "format" : "int64" }, "countryid" : { "type" : "integer", "format" : "int64" }, "ticket_start_date" : { "type" : "string", "format" : "date-time" }, "ticket_closed_date" : { "type" : "string", "format" : "date-time" }, "notified_by_phone" : { "type" : "string" }, "notified_by_email" : { "type" : "string" }, "active" : { "type" : "boolean" }, "excavator" : { "type" : "string" }, "locator_id" : { "type" : "integer", "format" : "int64" }, "locator_first_nm" : { "type" : "string" }, "locator_last_nm" : { "type" : "string" }, "cross_str2" : { "type" : "string" }, "county" : { "type" : "string" }, "ticket_type" : { "type" : "string" }, "type_of_work" : { "type" : "string" }, "boring" : { "type" : "boolean" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "source" : { "type" : "string" }, "notified_by_extension" : { "type" : "integer", "format" : "int32" }, "search_text" : { "type" : "string" }, "caller_company" : { "type" : "string" }, "paged_date_time" : { "type" : "string", "format" : "date-time" }, "confirmaton_date_time" : { "type" : "string", "format" : "date-time" }, "customer_rep" : { "type" : "string" }, "cdi_confirmation" : { "type" : "string" }, "latitude" : { "type" : "number", "format" : "double" }, "longitude" : { "type" : "number", "format" : "double" }, "geo_location" : { "type" : "string" }, "utility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_id" : { "type" : "integer", "format" : "int64" }, "dots_number" : { "type" : "string" }, "customer_claim_number" : { "type" : "string" }, "customer_claim_number_2" : { "type" : "string" }, "supgroup" : { "type" : "string" }, "one_call_request_ticket_id" : { "type" : "integer", "format" : "int64" }, "claims" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Claim" } }, "legalDamages" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalDamage" } }, "claimDetails" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimDetail" } }, "investigation" : { "$ref" : "#/components/schemas/Investigation" }, "policyDropOffEstimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimate" } }, "district" : { "$ref" : "#/components/schemas/District" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "state" : { "$ref" : "#/components/schemas/State" }, "damageListings" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/DamageListing" } }, "investigationVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationVersion" } }, "damagePhotos" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/DamagePhoto" } } } }, "DamageCustomer" : { "type" : "object", "properties" : { "damageCustomerKey" : { "$ref" : "#/components/schemas/DamageCustomerKey" }, "customer_id" : { "type" : "integer", "format" : "int64" }, "damage_id" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "cmsCustomer" : { "$ref" : "#/components/schemas/CMSCustomer" }, "damage" : { "$ref" : "#/components/schemas/Damage" } } }, "DamageCustomerKey" : { "type" : "object", "properties" : { "damage_id" : { "type" : "integer", "format" : "int64" }, "customer_id" : { "type" : "integer", "format" : "int64" } } }, "DamageListing" : { "type" : "object", "properties" : { "damageListingPK" : { "$ref" : "#/components/schemas/DamageListingPK" }, "dl_notification_id" : { "type" : "string" }, "dl_damage_id" : { "type" : "integer", "format" : "int64" }, "dl_add1" : { "type" : "string" }, "dl_city" : { "type" : "string" }, "dl_abbrev" : { "type" : "string" }, "dl_damage_date_time" : { "type" : "string", "format" : "date-time" }, "dl_excavator" : { "type" : "string" }, "dl_customer_id" : { "type" : "integer", "format" : "int64" }, "dl_account_number" : { "type" : "integer", "format" : "int64" }, "dl_customer_claim_number" : { "type" : "string" }, "dl_duplicate_damage_id" : { "type" : "integer", "format" : "int64" }, "damage" : { "$ref" : "#/components/schemas/Damage" }, "duplicateDamage" : { "$ref" : "#/components/schemas/Damage" } } }, "DamageListingPK" : { "type" : "object", "properties" : { "dl_notification_id" : { "type" : "string" }, "dl_customer_id" : { "type" : "integer", "format" : "int64" } } }, "DamagePhoto" : { "type" : "object", "properties" : { "attachment_id" : { "type" : "integer", "format" : "int64" }, "volume_id" : { "type" : "integer", "format" : "int64" }, "priv" : { "type" : "boolean" }, "path" : { "type" : "string" }, "filetype" : { "type" : "string" }, "filename" : { "type" : "string" }, "filesize" : { "type" : "string" }, "attachment_entity_id" : { "type" : "integer", "format" : "int64" }, "pk1_int" : { "type" : "integer", "format" : "int64" }, "attachment_entity_name" : { "type" : "string" }, "entity_table" : { "type" : "string" }, "protocol" : { "type" : "string" }, "fullUrl" : { "type" : "string" }, "fulltnUrl" : { "type" : "string" }, "number" : { "type" : "string" }, "damage" : { "$ref" : "#/components/schemas/Damage" }, "attachmentEntities" : { "$ref" : "#/components/schemas/AttachmentEntities" }, "cmsInvestigationDetail" : { "$ref" : "#/components/schemas/CMSInvestigationDetail" }, "investigationDetail" : { "$ref" : "#/components/schemas/InvestigationDetail" }, "host" : { "type" : "string" }, "entityID" : { "type" : "integer", "format" : "int64" }, "vol" : { "type" : "integer", "format" : "int64" } } }, "DeletionType" : { "type" : "object", "properties" : { "deletion_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "assets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } } } }, "DeviceToken" : { "type" : "object", "properties" : { "device_token_id" : { "type" : "integer", "format" : "int64" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "device_token" : { "type" : "string" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "employee" : { "$ref" : "#/components/schemas/Employee" } } }, "District" : { "type" : "object", "properties" : { "district_id" : { "type" : "integer", "format" : "int64" }, "workday_id" : { "type" : "integer", "format" : "int64" }, "district_code" : { "type" : "integer", "format" : "int64" }, "district_abbr" : { "type" : "string" }, "district_name" : { "type" : "string" }, "state" : { "type" : "string" }, "region" : { "type" : "string" }, "district_manager_employee_id" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "employees" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Employee" } }, "employeesOnLoans" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/EmployeeOnLoan" } }, "employeesActiveNoAssets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAsset" } }, "supervisorGroups" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/SupervisorGroup" } }, "assets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } }, "districtLocations" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/DistrictLocation" } }, "userDataAccesses" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/UserDataAccesses" } }, "locations" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Location" } } } }, "DistrictLocation" : { "type" : "object", "properties" : { "district_location_id" : { "type" : "integer", "format" : "int64" }, "district_id" : { "type" : "integer", "format" : "int64" }, "location_id" : { "type" : "integer", "format" : "int64" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "dist" : { "$ref" : "#/components/schemas/District" }, "location" : { "$ref" : "#/components/schemas/Location" } } }, "Employee" : { "type" : "object", "properties" : { "employee_key" : { "type" : "integer", "format" : "int64" }, "emp_id" : { "type" : "integer", "format" : "int64" }, "emp_type" : { "type" : "string" }, "legal_name" : { "type" : "string" }, "legal_name_last" : { "type" : "string" }, "legal_name_first" : { "type" : "string" }, "job_code" : { "type" : "integer", "format" : "int32" }, "position" : { "type" : "string" }, "email" : { "type" : "string" }, "active_status" : { "type" : "string" }, "effective_date" : { "type" : "string", "format" : "date-time" }, "sup_group_id" : { "type" : "integer", "format" : "int64" }, "sup_group_code" : { "type" : "string" }, "sup_emp_id" : { "type" : "integer", "format" : "int64" }, "supervisor" : { "type" : "string" }, "district_id" : { "type" : "integer", "format" : "int64" }, "district" : { "type" : "string" }, "district_abbr" : { "type" : "string" }, "state" : { "type" : "string" }, "region" : { "type" : "string" }, "eff_sup_group_id" : { "type" : "integer", "format" : "int64" }, "eff_sup_group_code" : { "type" : "string" }, "eff_sup_emp_id" : { "type" : "integer", "format" : "int64" }, "eff_supervisor" : { "type" : "string" }, "eff_district_id" : { "type" : "integer", "format" : "int64" }, "eff_district" : { "type" : "string" }, "eff_district_abbr" : { "type" : "string" }, "eff_state" : { "type" : "string" }, "eff_region" : { "type" : "string" }, "exclusion_code" : { "type" : "integer", "format" : "int32" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "action" : { "type" : "string" }, "reason" : { "type" : "string" }, "estimated_return_date" : { "type" : "string", "format" : "date-time" }, "dist" : { "$ref" : "#/components/schemas/District" }, "supgroup" : { "$ref" : "#/components/schemas/SupervisorGroup" }, "announcements" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Announcement" } }, "assetAssignments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetAssignment" } }, "assignments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetAssignment" } }, "requests" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Request" } }, "acceptedAssets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } }, "wirelessInventories" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/WirelessInventory" } }, "vehicles" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Vehicle" } }, "userDataAccesses" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/UserDataAccesses" } }, "locatorCheckins" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LocatorCheckin" } }, "deviceTokens" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/DeviceToken" } }, "employeeMessages" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/EmployeeMessage" } }, "messages" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Message" } }, "schedulerJobsInfo" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/SchedulerJobInfo" } }, "investigations" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Investigation" } }, "comments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } }, "ideas" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Idea" } }, "display_name" : { "type" : "string" } } }, "EmployeeMessage" : { "type" : "object", "properties" : { "uuid" : { "type" : "string" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "message_id" : { "type" : "integer", "format" : "int64" }, "status_id" : { "type" : "integer", "format" : "int64" }, "sent_at" : { "type" : "string", "format" : "date-time" }, "first_read_at" : { "type" : "string", "format" : "date-time" }, "last_read_at" : { "type" : "string", "format" : "date-time" }, "cleared_at" : { "type" : "string", "format" : "date-time" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "reference_id" : { "type" : "string" }, "acknowledged_at" : { "type" : "string", "format" : "date-time" }, "channel" : { "type" : "string" }, "recipient_email" : { "type" : "string" }, "delivery_detail" : { "type" : "string" }, "delivery_attempts" : { "type" : "integer", "format" : "int32" }, "claimed_at" : { "type" : "string", "format" : "date-time" }, "schedulerInfo" : { "$ref" : "#/components/schemas/SchedulerInfo" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "message" : { "$ref" : "#/components/schemas/Message" }, "messageWithCount" : { "$ref" : "#/components/schemas/MessageWithCount" }, "status" : { "$ref" : "#/components/schemas/Status" } } }, "EmployeeOnLoan" : { "type" : "object", "properties" : { "employee_key" : { "type" : "integer", "format" : "int64" }, "emp_id" : { "type" : "integer", "format" : "int64" }, "emp_type" : { "type" : "string" }, "legal_name" : { "type" : "string" }, "legal_name_last" : { "type" : "string" }, "legal_name_first" : { "type" : "string" }, "job_code" : { "type" : "integer", "format" : "int32" }, "position" : { "type" : "string" }, "email" : { "type" : "string" }, "active_status" : { "type" : "string" }, "effective_date" : { "type" : "string", "format" : "date-time" }, "sup_group_id" : { "type" : "integer", "format" : "int64" }, "sup_group_code" : { "type" : "string" }, "sup_emp_id" : { "type" : "integer", "format" : "int64" }, "supervisor" : { "type" : "string" }, "district_id" : { "type" : "integer", "format" : "int64" }, "district" : { "type" : "string" }, "district_abbr" : { "type" : "string" }, "state" : { "type" : "string" }, "region" : { "type" : "string" }, "eff_sup_group_id" : { "type" : "integer", "format" : "int64" }, "eff_sup_group_code" : { "type" : "string" }, "eff_sup_emp_id" : { "type" : "integer", "format" : "int64" }, "eff_supervisor" : { "type" : "string" }, "eff_district_id" : { "type" : "integer", "format" : "int64" }, "eff_district" : { "type" : "string" }, "eff_district_abbr" : { "type" : "string" }, "eff_state" : { "type" : "string" }, "eff_region" : { "type" : "string" }, "exclusion_code" : { "type" : "integer", "format" : "int32" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "dist" : { "$ref" : "#/components/schemas/District" }, "supgroup" : { "$ref" : "#/components/schemas/SupervisorGroup" }, "assetAssignments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetAssignment" } }, "vehicles" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Vehicle" } }, "wirelessInventories" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/WirelessInventory" } } } }, "EmployeesActiveMultipleItAssets" : { "type" : "object", "properties" : { "employee_key" : { "type" : "integer", "format" : "int64" }, "emp_id" : { "type" : "integer", "format" : "int64" }, "emp_type" : { "type" : "string" }, "legal_name" : { "type" : "string" }, "legal_name_last" : { "type" : "string" }, "legal_name_first" : { "type" : "string" }, "job_code" : { "type" : "integer", "format" : "int32" }, "position" : { "type" : "string" }, "email" : { "type" : "string" }, "active_status" : { "type" : "string" }, "effective_date" : { "type" : "string", "format" : "date-time" }, "sup_group_id" : { "type" : "integer", "format" : "int64" }, "sup_group_code" : { "type" : "string" }, "sup_emp_id" : { "type" : "integer", "format" : "int64" }, "supervisor" : { "type" : "string" }, "district_id" : { "type" : "integer", "format" : "int64" }, "district" : { "type" : "string" }, "district_abbr" : { "type" : "string" }, "state" : { "type" : "string" }, "region" : { "type" : "string" }, "eff_sup_group_id" : { "type" : "integer", "format" : "int64" }, "eff_sup_group_code" : { "type" : "string" }, "eff_sup_emp_id" : { "type" : "integer", "format" : "int64" }, "eff_supervisor" : { "type" : "string" }, "eff_district_id" : { "type" : "integer", "format" : "int64" }, "eff_district" : { "type" : "string" }, "eff_district_abbr" : { "type" : "string" }, "eff_state" : { "type" : "string" }, "eff_region" : { "type" : "string" }, "exclusion_code" : { "type" : "integer", "format" : "int32" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "action" : { "type" : "string" }, "reason" : { "type" : "string" }, "estimated_return_date" : { "type" : "string", "format" : "date-time" }, "dist" : { "$ref" : "#/components/schemas/District" }, "supgroup" : { "$ref" : "#/components/schemas/SupervisorGroup" }, "vehicles" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Vehicle" } }, "assetAssignments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetAssignment" } } } }, "EmployeesActiveNoAsset" : { "type" : "object", "properties" : { "employee_key" : { "type" : "integer", "format" : "int64" }, "emp_id" : { "type" : "integer", "format" : "int64" }, "emp_type" : { "type" : "string" }, "legal_name" : { "type" : "string" }, "legal_name_last" : { "type" : "string" }, "legal_name_first" : { "type" : "string" }, "job_code" : { "type" : "integer", "format" : "int32" }, "position" : { "type" : "string" }, "email" : { "type" : "string" }, "active_status" : { "type" : "string" }, "effective_date" : { "type" : "string", "format" : "date-time" }, "sup_group_id" : { "type" : "integer", "format" : "int64" }, "sup_group_code" : { "type" : "string" }, "sup_emp_id" : { "type" : "integer", "format" : "int64" }, "supervisor" : { "type" : "string" }, "district_id" : { "type" : "integer", "format" : "int64" }, "district" : { "type" : "string" }, "district_abbr" : { "type" : "string" }, "state" : { "type" : "string" }, "region" : { "type" : "string" }, "eff_sup_group_id" : { "type" : "integer", "format" : "int64" }, "eff_sup_group_code" : { "type" : "string" }, "eff_sup_emp_id" : { "type" : "integer", "format" : "int64" }, "eff_supervisor" : { "type" : "string" }, "eff_district_id" : { "type" : "integer", "format" : "int64" }, "eff_district" : { "type" : "string" }, "eff_district_abbr" : { "type" : "string" }, "eff_state" : { "type" : "string" }, "eff_region" : { "type" : "string" }, "exclusion_code" : { "type" : "integer", "format" : "int32" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "dist" : { "$ref" : "#/components/schemas/District" }, "supgroup" : { "$ref" : "#/components/schemas/SupervisorGroup" }, "vehicles" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Vehicle" } }, "assetAssignments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AssetAssignment" } } } }, "Estimate" : { "type" : "object", "properties" : { "estimate_key" : { "$ref" : "#/components/schemas/EstimatePK" }, "estimate_id" : { "type" : "integer", "format" : "int64" }, "version_number" : { "type" : "integer", "format" : "int64" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "investigation_id" : { "type" : "integer", "format" : "int64" }, "investigation_detail_id" : { "type" : "integer", "format" : "int64" }, "damage_id" : { "type" : "integer", "format" : "int64" }, "wf_notification_id" : { "type" : "integer", "format" : "int64" }, "estimate_category_id" : { "type" : "integer", "format" : "int64" }, "period_id" : { "type" : "integer", "format" : "int64" }, "district_id" : { "type" : "integer", "format" : "int64" }, "request_id" : { "type" : "integer", "format" : "int64" }, "dispute_reason_id" : { "type" : "integer", "format" : "int64" }, "dispute_estimate" : { "type" : "boolean" }, "accrued" : { "type" : "boolean" }, "count_against_quality_ratio" : { "type" : "boolean" }, "third_party_name" : { "type" : "string" }, "amount" : { "type" : "number", "format" : "double" }, "default_amount" : { "type" : "number", "format" : "double" }, "adjusted_amount" : { "type" : "number", "format" : "double" }, "accrual_amount" : { "type" : "number", "format" : "double" }, "difference_reason_id" : { "type" : "integer", "format" : "int64" }, "estimate_date" : { "type" : "string", "format" : "date-time" }, "change_reason" : { "type" : "string" }, "completed" : { "type" : "boolean" }, "approver" : { "type" : "integer", "format" : "int64" }, "completed_by" : { "type" : "integer", "format" : "int64" }, "completed_date" : { "type" : "string", "format" : "date-time" }, "active" : { "type" : "boolean" }, "policy_drop_off_period_id" : { "type" : "integer", "format" : "int64" }, "policy_drop_off" : { "type" : "boolean" }, "policy_drop_off_month" : { "type" : "integer", "format" : "int32" }, "policy_drop_off_year" : { "type" : "integer", "format" : "int32" }, "policy_drop_off_amount" : { "type" : "number", "format" : "double" }, "prorated_payment_amount" : { "type" : "number", "format" : "double" }, "attributes1" : { "type" : "string" }, "attributes2" : { "type" : "string" }, "attributes3" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "accrual_balance" : { "type" : "number", "format" : "double" }, "cmsInvestigationDetail" : { "$ref" : "#/components/schemas/CMSInvestigationDetail" }, "investigation" : { "$ref" : "#/components/schemas/Investigation" }, "district" : { "$ref" : "#/components/schemas/District" }, "financialPeriod" : { "$ref" : "#/components/schemas/FinancialPeriod" }, "quickCValue" : { "$ref" : "#/components/schemas/QuickCValue" }, "cmsRequest" : { "$ref" : "#/components/schemas/CmsRequest" } } }, "EstimatePK" : { "type" : "object", "properties" : { "estimate_id" : { "type" : "integer", "format" : "int64" }, "version_number" : { "type" : "integer", "format" : "int64" } } }, "Excavator" : { "type" : "object", "properties" : { "excavator_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "contact_name" : { "type" : "string" }, "contact_phone_number" : { "type" : "string" }, "contact_email" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "investigations" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Investigation" } } } }, "Facility" : { "type" : "object", "properties" : { "fd_detail_id" : { "type" : "integer", "format" : "int64" }, "fd_damage_id" : { "type" : "integer", "format" : "int64" }, "fd_investigation_id" : { "type" : "integer", "format" : "int64" }, "fd_customer_name" : { "type" : "string" }, "flatRateCustomers" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/FlatRateCustomer" } }, "billableCustomers" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/BillableCustomer" } }, "damage" : { "$ref" : "#/components/schemas/Damage" }, "investigation" : { "$ref" : "#/components/schemas/Investigation" } } }, "FinancialPeriod" : { "type" : "object", "properties" : { "period_id" : { "type" : "integer", "format" : "int64" }, "period_name" : { "type" : "string" }, "year" : { "type" : "integer", "format" : "int32" }, "start_date" : { "type" : "string", "format" : "date-time" }, "end_date" : { "type" : "string", "format" : "date-time" }, "status_id" : { "type" : "integer", "format" : "int64" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "closed_for_estimates" : { "type" : "boolean" }, "estimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Estimate" } }, "accrualSummaries" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AccrualSummary" } }, "accruals" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Accrual" } }, "claims" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Claim" } }, "legalRisks" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalRisk" } }, "policyDropOffEstimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimate" } } } }, "FlatRateCustomer" : { "type" : "object", "properties" : { "flat_rate_customers_id" : { "type" : "integer", "format" : "int64" }, "customer_id" : { "type" : "integer", "format" : "int64" }, "utility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_id" : { "type" : "integer", "format" : "int64" }, "state_id" : { "type" : "integer", "format" : "int64" }, "count_against_quality_guarantee" : { "type" : "boolean" }, "auto_approve_claims" : { "type" : "boolean" }, "approval_limit" : { "type" : "number", "format" : "double" }, "active" : { "type" : "boolean" }, "start_date" : { "type" : "string", "format" : "date-time" }, "end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "cmsCustomer" : { "$ref" : "#/components/schemas/CMSCustomer" }, "facility" : { "$ref" : "#/components/schemas/Facility" }, "state" : { "$ref" : "#/components/schemas/State" } } }, "Idea" : { "type" : "object", "properties" : { "idea_id" : { "type" : "integer", "format" : "int64" }, "title" : { "type" : "string" }, "content" : { "type" : "string" }, "kind_id" : { "type" : "integer", "format" : "int64" }, "author_id" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "active" : { "type" : "boolean" }, "approved_or_rejected_on" : { "type" : "string", "format" : "date-time" }, "approved_or_rejected_by" : { "type" : "string" }, "approved" : { "type" : "boolean" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "kind" : { "$ref" : "#/components/schemas/IdeaKind" }, "comments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Comment" } }, "votes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Vote" } } } }, "IdeaKind" : { "type" : "object", "properties" : { "kind_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "sort_order" : { "type" : "integer", "format" : "int32" }, "active" : { "type" : "boolean" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" } } }, "Investigation" : { "type" : "object", "properties" : { "investigation_id" : { "type" : "integer", "format" : "int64" }, "damage_id" : { "type" : "integer", "format" : "int64" }, "excavator_id" : { "type" : "integer", "format" : "int64" }, "excavation_type_id" : { "type" : "integer", "format" : "int64" }, "ticket_id" : { "type" : "integer", "format" : "int64" }, "ticket_number" : { "type" : "string" }, "ticket_start_date" : { "type" : "string", "format" : "date-time" }, "ticket_closed_date" : { "type" : "string", "format" : "date-time" }, "inv_start_date" : { "type" : "string", "format" : "date-time" }, "inv_end_date" : { "type" : "string", "format" : "date-time" }, "dig_up_dmg_req" : { "type" : "string" }, "dig_up_dmg_ticket" : { "type" : "boolean" }, "pics_taken_by" : { "type" : "integer", "format" : "int64" }, "approved" : { "type" : "boolean" }, "approved_date" : { "type" : "string", "format" : "date-time" }, "approver" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "district_id" : { "type" : "integer", "format" : "int64" }, "add_1" : { "type" : "string" }, "add_2" : { "type" : "string" }, "city" : { "type" : "string" }, "stateid" : { "type" : "integer", "format" : "int64" }, "zip" : { "type" : "string" }, "county" : { "type" : "string" }, "countryid" : { "type" : "integer", "format" : "int64" }, "cross_str1" : { "type" : "string" }, "cross_str2" : { "type" : "string" }, "excavator" : { "type" : "string" }, "locator_id" : { "type" : "integer", "format" : "int64" }, "locator_first_nm" : { "type" : "string" }, "locator_last_nm" : { "type" : "string" }, "ticket_type" : { "type" : "string" }, "type_of_work" : { "type" : "string" }, "boring" : { "type" : "boolean" }, "completed" : { "type" : "boolean" }, "owner" : { "type" : "string" }, "completed_date" : { "type" : "string", "format" : "date-time" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "search_text" : { "type" : "string" }, "latitude" : { "type" : "number", "format" : "double" }, "longitude" : { "type" : "number", "format" : "double" }, "geo_location" : { "type" : "string" }, "dots_number" : { "type" : "string" }, "customer_claim_number" : { "type" : "string" }, "customer_claim_number_2" : { "type" : "string" }, "post_approver_change" : { "type" : "boolean" }, "change_reason_id" : { "type" : "integer", "format" : "int64" }, "change_reason_text" : { "type" : "string" }, "one_call_request_ticket_id" : { "type" : "integer", "format" : "int64" }, "damage" : { "$ref" : "#/components/schemas/Damage" }, "questionnaireAnswersVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersVersion" } }, "excavationType" : { "$ref" : "#/components/schemas/QuickCValue" }, "excavat" : { "$ref" : "#/components/schemas/Excavator" }, "investigationDetails" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationDetail" } }, "investigationDetailsVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersion" } }, "investigationVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationVersion" } }, "cmsInvestigationDetails" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/CMSInvestigationDetail" } }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "picsTakenEmployee" : { "$ref" : "#/components/schemas/Employee" }, "questionnaireAnswers" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswer" } }, "policyDropOffEstimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimate" } }, "estimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Estimate" } }, "questionaireAnswersVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersVersion" } } } }, "InvestigationDetail" : { "type" : "object", "properties" : { "id_detail_id" : { "type" : "integer", "format" : "int64" }, "id_investigation_id" : { "type" : "integer", "format" : "int64" }, "id_notification_id" : { "type" : "string" }, "id_damage_id" : { "type" : "integer", "format" : "int64" }, "id_customer_id" : { "type" : "integer", "format" : "int64" }, "id_account_level_customer_id" : { "type" : "integer", "format" : "int64" }, "id_damage_customer" : { "type" : "string" }, "id_utility" : { "type" : "string" }, "id_facility" : { "type" : "string" }, "id_facility_type" : { "type" : "string" }, "id_locator_name" : { "type" : "string" }, "id_cause_factor" : { "type" : "string" }, "id_were_markings_visible" : { "type" : "string" }, "id_other_indicators" : { "type" : "string" }, "id_tolerence_zone" : { "type" : "string" }, "id_facility_damage" : { "type" : "string" }, "id_replacement_footage" : { "type" : "string" }, "id_contractor_assistance" : { "type" : "string" }, "id_contractor_equipment" : { "type" : "integer", "format" : "int64" }, "id_facility_shown" : { "type" : "string" }, "id_record_numbers" : { "type" : "integer", "format" : "int64" }, "inv_report_attachment_id" : { "type" : "integer", "format" : "int64" }, "investigation" : { "$ref" : "#/components/schemas/Investigation" }, "investigationReport" : { "$ref" : "#/components/schemas/DamagePhoto" }, "investigationDetailsVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersion" } }, "policyDropOffEstimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimate" } }, "claimDetails" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimDetail" } } } }, "InvestigationDetailLine" : { "type" : "object", "properties" : { "detail_line_id" : { "type" : "integer", "format" : "int64" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "active" : { "type" : "boolean" }, "detail_id" : { "type" : "integer", "format" : "int64" }, "contract_number" : { "type" : "string" }, "report_sent" : { "type" : "boolean" }, "billable_to_customer" : { "type" : "boolean" }, "count_against_quality_ratio" : { "type" : "boolean" }, "customer_claim_number" : { "type" : "string" }, "accepted_date" : { "type" : "string", "format" : "date-time" }, "report_sent_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "att1" : { "type" : "string" }, "att2" : { "type" : "string" }, "att3" : { "type" : "string" }, "att4" : { "type" : "string" }, "att5" : { "type" : "string" }, "contract_id" : { "type" : "string" }, "cdc_code" : { "type" : "string" }, "adjuster_time" : { "type" : "integer", "format" : "int32" }, "cmsInvestigationDetail" : { "$ref" : "#/components/schemas/CMSInvestigationDetail" } } }, "InvestigationDetailsVersion" : { "type" : "object", "properties" : { "investigation_detail_version_id" : { "type" : "integer", "format" : "int64" }, "detail_id" : { "type" : "integer", "format" : "int64" }, "investigation_id" : { "type" : "integer", "format" : "int64" }, "customer_id" : { "type" : "integer", "format" : "int64" }, "utility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_id" : { "type" : "integer", "format" : "int64" }, "locator_id" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "active" : { "type" : "boolean" }, "investigation_root_cause_id" : { "type" : "integer", "format" : "int64" }, "completed" : { "type" : "boolean" }, "completed_by" : { "type" : "integer", "format" : "int64" }, "completed_date" : { "type" : "string", "format" : "date-time" }, "search_text" : { "type" : "string" }, "att1" : { "type" : "string" }, "att2" : { "type" : "string" }, "att3" : { "type" : "string" }, "att4" : { "type" : "string" }, "att5" : { "type" : "string" }, "changed_date" : { "type" : "string", "format" : "date-time" }, "changed_by" : { "type" : "integer", "format" : "int64" }, "investigation_version_id" : { "type" : "integer", "format" : "int64" }, "investigationVersion" : { "$ref" : "#/components/schemas/InvestigationVersion" }, "investigationDetail" : { "$ref" : "#/components/schemas/InvestigationDetail" }, "investigation" : { "$ref" : "#/components/schemas/Investigation" }, "locator" : { "$ref" : "#/components/schemas/Employee" }, "completedBy" : { "$ref" : "#/components/schemas/Employee" }, "changedBy" : { "$ref" : "#/components/schemas/Employee" }, "cmsCustomer" : { "$ref" : "#/components/schemas/CMSCustomer" } } }, "InvestigationVersion" : { "type" : "object", "properties" : { "investigation_version_id" : { "type" : "integer", "format" : "int64" }, "investigation_id" : { "type" : "integer", "format" : "int64" }, "damage_id" : { "type" : "integer", "format" : "int64" }, "excavator_id" : { "type" : "integer", "format" : "int64" }, "excavation_type_id" : { "type" : "integer", "format" : "int64" }, "ticket_id" : { "type" : "integer", "format" : "int64" }, "ticket_number" : { "type" : "string" }, "ticket_start_date" : { "type" : "string", "format" : "date-time" }, "ticket_closed_date" : { "type" : "string", "format" : "date-time" }, "inv_start_date" : { "type" : "string", "format" : "date-time" }, "inv_end_date" : { "type" : "string", "format" : "date-time" }, "dig_up_dmg_req" : { "type" : "string" }, "dig_up_dmg_ticket" : { "type" : "boolean" }, "pics_taken_by" : { "type" : "integer", "format" : "int64" }, "approved" : { "type" : "boolean" }, "approved_date" : { "type" : "string", "format" : "date-time" }, "approver" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "district_id" : { "type" : "integer", "format" : "int64" }, "add_1" : { "type" : "string" }, "add_2" : { "type" : "string" }, "city" : { "type" : "string" }, "stateid" : { "type" : "integer", "format" : "int64" }, "zip" : { "type" : "string" }, "county" : { "type" : "string" }, "countryid" : { "type" : "integer", "format" : "int64" }, "cross_str1" : { "type" : "string" }, "cross_str2" : { "type" : "string" }, "excavator" : { "type" : "string" }, "locator_id" : { "type" : "integer", "format" : "int64" }, "locator_first_nm" : { "type" : "string" }, "locator_last_nm" : { "type" : "string" }, "ticket_type" : { "type" : "string" }, "type_of_work" : { "type" : "string" }, "boring" : { "type" : "boolean" }, "completed" : { "type" : "boolean" }, "owner" : { "type" : "string" }, "completed_date" : { "type" : "string", "format" : "date-time" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "search_text" : { "type" : "string" }, "latitude" : { "type" : "number", "format" : "double" }, "longitude" : { "type" : "number", "format" : "double" }, "geo_location" : { "type" : "string" }, "dots_number" : { "type" : "string" }, "customer_claim_number" : { "type" : "string" }, "changed_date" : { "type" : "string", "format" : "date-time" }, "changed_by" : { "type" : "integer", "format" : "int64" }, "post_approver_change" : { "type" : "boolean" }, "change_reason_id" : { "type" : "integer", "format" : "int64" }, "change_reason_text" : { "type" : "string" }, "one_call_request_ticket_id" : { "type" : "integer", "format" : "int64" }, "customer_claim_number_2" : { "type" : "string" }, "investigation" : { "$ref" : "#/components/schemas/Investigation" }, "damage" : { "$ref" : "#/components/schemas/Damage" }, "approverEmployee" : { "$ref" : "#/components/schemas/Employee" }, "picsTakenByEmployee" : { "$ref" : "#/components/schemas/Employee" }, "investigationDetailsVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/InvestigationDetailsVersion" } } } }, "JobDetailsInfo" : { "type" : "object", "properties" : { "schedulerName" : { "type" : "string" }, "previousFireTime" : { "type" : "string" }, "nextFireTime" : { "type" : "string" }, "priority" : { "type" : "integer", "format" : "int32" } } }, "LawFirm" : { "type" : "object", "properties" : { "law_firm_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "active" : { "type" : "boolean" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "legalCases" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalCase" } }, "legalParties" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalParty" } } } }, "LegalCase" : { "type" : "object", "properties" : { "case_id" : { "type" : "integer", "format" : "int64" }, "cases_type_id" : { "type" : "integer", "format" : "int64" }, "cases_sub_type_id" : { "type" : "integer", "format" : "int64" }, "case_manager_id" : { "type" : "integer", "format" : "int64" }, "insurance_adjuster_id" : { "type" : "integer", "format" : "int64" }, "law_firm_id" : { "type" : "integer", "format" : "int64" }, "legal_party_id" : { "type" : "integer", "format" : "int64" }, "sued_by_type_id" : { "type" : "integer", "format" : "int64" }, "law_firm_site_id" : { "type" : "integer", "format" : "int64" }, "case_name" : { "type" : "string" }, "litigation_status_id" : { "type" : "integer", "format" : "int64" }, "date_served" : { "type" : "string", "format" : "date-time" }, "date_sent_to_attorney" : { "type" : "string", "format" : "date-time" }, "matter_number" : { "type" : "string" }, "court_case_number" : { "type" : "string" }, "damage_agreed_date" : { "type" : "string", "format" : "date-time" }, "insurance_claim" : { "type" : "integer", "format" : "int32" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "search_text" : { "type" : "string" }, "case_status" : { "type" : "integer", "format" : "int32" }, "closed_date" : { "type" : "string", "format" : "date-time" }, "trial_date" : { "type" : "string", "format" : "date-time" }, "mediation_date" : { "type" : "string", "format" : "date-time" }, "lawFirm" : { "$ref" : "#/components/schemas/LawFirm" }, "legalParty" : { "$ref" : "#/components/schemas/LegalParty" }, "casesType" : { "$ref" : "#/components/schemas/CasesType" }, "casesSubtype" : { "$ref" : "#/components/schemas/CasesSubtype" }, "legalDamages" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalDamage" } }, "legalRisks" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalRisk" } }, "claimDetails" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimDetail" } } } }, "LegalDamage" : { "type" : "object", "properties" : { "legal_damage_id" : { "type" : "integer", "format" : "int64" }, "damage_id" : { "type" : "integer", "format" : "int64" }, "case_id" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "damage" : { "$ref" : "#/components/schemas/Damage" }, "legalCase" : { "$ref" : "#/components/schemas/LegalCase" } } }, "LegalParty" : { "type" : "object", "properties" : { "legal_party_id" : { "type" : "integer", "format" : "int64" }, "legal_party_type_id" : { "type" : "integer", "format" : "int64" }, "law_firm_id" : { "type" : "integer", "format" : "int64" }, "first_name" : { "type" : "string" }, "last_name" : { "type" : "string" }, "middle_name" : { "type" : "string" }, "preferred_name" : { "type" : "string" }, "address1" : { "type" : "string" }, "address2" : { "type" : "string" }, "city" : { "type" : "string" }, "state" : { "type" : "string" }, "zip" : { "type" : "string" }, "country" : { "type" : "string" }, "phone" : { "type" : "string" }, "mobile" : { "type" : "string" }, "fax" : { "type" : "string" }, "email" : { "type" : "string" }, "active" : { "type" : "boolean" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "countryid" : { "type" : "integer", "format" : "int64" }, "stateid" : { "type" : "integer", "format" : "int64" }, "legalCases" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/LegalCase" } }, "lawFirm" : { "$ref" : "#/components/schemas/LawFirm" } } }, "LegalRisk" : { "type" : "object", "properties" : { "legalRisk_key" : { "$ref" : "#/components/schemas/LegalRiskPK" }, "legal_risk_id" : { "type" : "integer", "format" : "int64" }, "version_number" : { "type" : "integer", "format" : "int32" }, "case_id" : { "type" : "integer", "format" : "int64" }, "active" : { "type" : "boolean" }, "lawsuit_demand_amount" : { "type" : "number", "format" : "double" }, "estimate" : { "type" : "boolean" }, "accrual_amount" : { "type" : "number", "format" : "double" }, "accrual_flag" : { "type" : "boolean" }, "period_id" : { "type" : "integer", "format" : "int64" }, "request_id" : { "type" : "integer", "format" : "int64" }, "liability_age" : { "type" : "integer", "format" : "int32" }, "settlement_reserve" : { "type" : "number", "format" : "double" }, "expense_reserve" : { "type" : "number", "format" : "double" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "expense_accrual_balance" : { "type" : "number", "format" : "double" }, "settlement_accrual_balance" : { "type" : "number", "format" : "double" }, "legalCase" : { "$ref" : "#/components/schemas/LegalCase" }, "financialPeriod" : { "$ref" : "#/components/schemas/FinancialPeriod" }, "cmsRequest" : { "$ref" : "#/components/schemas/CmsRequest" } } }, "LegalRiskPK" : { "type" : "object", "properties" : { "legal_risk_id" : { "type" : "integer", "format" : "int64" }, "version_number" : { "type" : "integer", "format" : "int32" } } }, "Location" : { "type" : "object", "properties" : { "location_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "location_type_id" : { "type" : "integer", "format" : "int32" }, "address1" : { "type" : "string" }, "address2" : { "type" : "string" }, "city" : { "type" : "string" }, "state_id" : { "type" : "integer", "format" : "int32" }, "zip" : { "type" : "string" }, "country_id" : { "type" : "integer", "format" : "int32" }, "phone" : { "type" : "string" }, "mobile" : { "type" : "string" }, "fax" : { "type" : "string" }, "email" : { "type" : "string" }, "latitude" : { "type" : "number", "format" : "double" }, "longitude" : { "type" : "number", "format" : "double" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "district_id" : { "type" : "integer", "format" : "int64" }, "contact_name" : { "type" : "string" }, "districtLocations" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/DistrictLocation" } }, "country" : { "$ref" : "#/components/schemas/Country" }, "state" : { "$ref" : "#/components/schemas/State" }, "assets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } }, "districts" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/District" } } } }, "LocatorCheckin" : { "type" : "object", "properties" : { "checkin_id" : { "type" : "integer", "format" : "int64" }, "emp_id" : { "type" : "integer", "format" : "int64" }, "checkin_action" : { "type" : "string" }, "serial_number" : { "type" : "string" }, "usic_tag" : { "type" : "string" }, "asset_id" : { "type" : "integer", "format" : "int64" }, "asset_version" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "reviewed_on" : { "type" : "string", "format" : "date-time" }, "reviewed_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "asset" : { "$ref" : "#/components/schemas/Asset" } } }, "Message" : { "type" : "object", "properties" : { "message_id" : { "type" : "integer", "format" : "int64" }, "message" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "subject" : { "type" : "string" }, "message_preview" : { "type" : "string" }, "require_acknowledgement" : { "type" : "boolean" }, "application" : { "type" : "string" }, "unreadCount" : { "type" : "integer", "format" : "int32" }, "readCount" : { "type" : "integer", "format" : "int32" }, "sentCount" : { "type" : "integer", "format" : "int32" }, "acknowledgedCount" : { "type" : "integer", "format" : "int32" }, "employeeMessages" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/EmployeeMessage" } }, "employee" : { "$ref" : "#/components/schemas/Employee" } } }, "MessageWithCount" : { "type" : "object", "properties" : { "message_id" : { "type" : "integer", "format" : "int64" }, "message" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "subject" : { "type" : "string" }, "message_preview" : { "type" : "string" }, "require_acknowledgement" : { "type" : "boolean" }, "application" : { "type" : "string" }, "unreadCount" : { "type" : "integer", "format" : "int32" }, "readCount" : { "type" : "integer", "format" : "int32" }, "sentCount" : { "type" : "integer", "format" : "int32" }, "acknowledgedCount" : { "type" : "integer", "format" : "int32" }, "employee" : { "$ref" : "#/components/schemas/Employee" } } }, "NetmotionDevice" : { "type" : "object", "properties" : { "device_group" : { "type" : "string" }, "disconnect_reason" : { "type" : "string" }, "last_connect" : { "type" : "string", "format" : "date-time" }, "last_user" : { "type" : "string" }, "locality_version" : { "type" : "string" }, "mobility_version" : { "type" : "string" }, "serial_number" : { "type" : "string" }, "operating_system" : { "type" : "string" }, "pid" : { "type" : "string" }, "registered" : { "type" : "string", "format" : "date-time" }, "last_disconnect" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "asset_id" : { "type" : "integer", "format" : "int64" }, "asset_category" : { "type" : "string" }, "asset" : { "$ref" : "#/components/schemas/Asset" } } }, "PayeeAddress" : { "type" : "object", "properties" : { "claim_payee_id" : { "type" : "integer", "format" : "int64" }, "payee" : { "type" : "string" }, "claim_payee_address_id" : { "type" : "integer", "format" : "int64" }, "address" : { "type" : "string" }, "start_date" : { "type" : "string", "format" : "date-time" }, "end_date" : { "type" : "string", "format" : "date-time" }, "workday_vendor_number" : { "type" : "string" }, "claims" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Claim" } } } }, "PolicyDropOffEstimate" : { "type" : "object", "properties" : { "estimate_id" : { "type" : "integer", "format" : "int64" }, "version_number" : { "type" : "integer", "format" : "int64" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "investigation_id" : { "type" : "integer", "format" : "int64" }, "investigation_detail_id" : { "type" : "integer", "format" : "int64" }, "damage_id" : { "type" : "integer", "format" : "int64" }, "wf_notification_id" : { "type" : "integer", "format" : "int64" }, "estimate_category_id" : { "type" : "integer", "format" : "int64" }, "period_id" : { "type" : "integer", "format" : "int64" }, "district_id" : { "type" : "integer", "format" : "int64" }, "request_id" : { "type" : "integer", "format" : "int64" }, "dispute_reason_id" : { "type" : "integer", "format" : "int64" }, "dispute_estimate" : { "type" : "boolean" }, "accrued" : { "type" : "boolean" }, "count_against_quality_ratio" : { "type" : "boolean" }, "third_party_name" : { "type" : "string" }, "amount" : { "type" : "number", "format" : "double" }, "default_amount" : { "type" : "number", "format" : "double" }, "adjusted_amount" : { "type" : "number", "format" : "double" }, "accrual_amount" : { "type" : "number", "format" : "double" }, "difference_reason_id" : { "type" : "integer", "format" : "int64" }, "estimate_date" : { "type" : "string", "format" : "date-time" }, "change_reason" : { "type" : "string" }, "completed" : { "type" : "boolean" }, "approver" : { "type" : "integer", "format" : "int64" }, "completed_by" : { "type" : "integer", "format" : "int64" }, "completed_date" : { "type" : "string", "format" : "date-time" }, "active" : { "type" : "boolean" }, "policy_drop_off_period_id" : { "type" : "integer", "format" : "int64" }, "policy_drop_off" : { "type" : "boolean" }, "policy_drop_off_month" : { "type" : "integer", "format" : "int32" }, "policy_drop_off_year" : { "type" : "integer", "format" : "int32" }, "policy_drop_off_amount" : { "type" : "number", "format" : "double" }, "prorated_payment_amount" : { "type" : "number", "format" : "double" }, "attributes1" : { "type" : "string" }, "attributes2" : { "type" : "string" }, "attributes3" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "accrual_balance" : { "type" : "number", "format" : "double" }, "investigation" : { "$ref" : "#/components/schemas/Investigation" }, "investigationDetail" : { "$ref" : "#/components/schemas/InvestigationDetail" }, "damage" : { "$ref" : "#/components/schemas/Damage" }, "wfNotification" : { "$ref" : "#/components/schemas/WfNotification" }, "financialPeriod" : { "$ref" : "#/components/schemas/FinancialPeriod" }, "quickCValue" : { "$ref" : "#/components/schemas/QuickCValue" }, "cmsRequest" : { "$ref" : "#/components/schemas/CmsRequest" }, "district" : { "$ref" : "#/components/schemas/District" } } }, "QuestionnaireAnswer" : { "type" : "object", "properties" : { "answer_id" : { "type" : "integer", "format" : "int64" }, "investigation_id" : { "type" : "integer", "format" : "int64" }, "investigation_detail_id" : { "type" : "integer", "format" : "int64" }, "question_id" : { "type" : "integer", "format" : "int64" }, "answer" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "investigation" : { "$ref" : "#/components/schemas/Investigation" }, "questionnaireQuestion" : { "$ref" : "#/components/schemas/QuestionnaireQuestion" }, "questionnaireAnswersVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersVersion" } }, "questionaireAnswersVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersVersion" } } } }, "QuestionnaireAnswersVersion" : { "type" : "object", "properties" : { "questionnaire_answers_version_id" : { "type" : "integer", "format" : "int64" }, "answer_id" : { "type" : "integer", "format" : "int64" }, "investigation_id" : { "type" : "integer", "format" : "int64" }, "investigation_detail_id" : { "type" : "integer", "format" : "int64" }, "question_id" : { "type" : "integer", "format" : "int64" }, "answer" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "changed_date" : { "type" : "string", "format" : "date-time" }, "changed_by" : { "type" : "integer", "format" : "int64" }, "investigation_version_id" : { "type" : "integer", "format" : "int64" }, "questionnaireAnswer" : { "$ref" : "#/components/schemas/QuestionnaireAnswer" }, "investigation" : { "$ref" : "#/components/schemas/Investigation" }, "questionnaireQuestion" : { "$ref" : "#/components/schemas/QuestionnaireQuestion" } } }, "QuestionnaireQuestion" : { "type" : "object", "properties" : { "question_id" : { "type" : "integer", "format" : "int64" }, "code" : { "type" : "string" }, "description" : { "type" : "string" }, "label" : { "type" : "string" }, "seq" : { "type" : "integer", "format" : "int32" }, "placement" : { "type" : "string" }, "start_date" : { "type" : "string", "format" : "date-time" }, "end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "master_question" : { "type" : "boolean" }, "criteria" : { "type" : "string" }, "type" : { "type" : "string" }, "visibility" : { "type" : "string" }, "required" : { "type" : "boolean" }, "questionnaireAnswers" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswer" } }, "questionnaireAnswersVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersVersion" } }, "questionaireAnswersVersions" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuestionnaireAnswersVersion" } } } }, "QuickC" : { "type" : "object", "properties" : { "quick_code_id" : { "type" : "integer", "format" : "int64" }, "code" : { "type" : "string" }, "display_name" : { "type" : "string" }, "start_date" : { "type" : "string", "format" : "date-time" }, "end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "quickCValues" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuickCValue" } } } }, "QuickCValue" : { "type" : "object", "properties" : { "value_id" : { "type" : "integer", "format" : "int64" }, "quick_code_id" : { "type" : "integer", "format" : "int64" }, "value" : { "type" : "string" }, "display_name" : { "type" : "string" }, "start_date" : { "type" : "string", "format" : "date-time" }, "end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "quickC" : { "$ref" : "#/components/schemas/QuickC" }, "estimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Estimate" } }, "investigations" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Investigation" } } } }, "QuickCode" : { "type" : "object", "properties" : { "quick_code_id" : { "type" : "integer", "format" : "int64" }, "code" : { "type" : "string" }, "display_name" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "quickCodeValues" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/QuickCodeValue" } }, "attributeMappings" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/AttributeMapping" } } } }, "QuickCodeValue" : { "type" : "object", "properties" : { "value_id" : { "type" : "integer", "format" : "int64" }, "quick_code_id" : { "type" : "integer", "format" : "int64" }, "value" : { "type" : "string" }, "display_name" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "quickCode" : { "$ref" : "#/components/schemas/QuickCode" } } }, "RepairReason" : { "type" : "object", "properties" : { "repair_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "notes" : { "type" : "string" }, "assets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } } } }, "Request" : { "type" : "object", "properties" : { "request_id" : { "type" : "integer", "format" : "int64" }, "emp_id" : { "type" : "integer", "format" : "int64" }, "userid" : { "type" : "integer", "format" : "int64" }, "username" : { "type" : "string" }, "session_id" : { "type" : "string" }, "start_time" : { "type" : "string", "format" : "date-time" }, "end_time" : { "type" : "string", "format" : "date-time" }, "request_name" : { "type" : "string" }, "request_type" : { "type" : "string" }, "completed_status" : { "type" : "string" }, "param1" : { "type" : "string" }, "param2" : { "type" : "string" }, "param3" : { "type" : "string" }, "param4" : { "type" : "string" }, "param5" : { "type" : "string" }, "param6" : { "type" : "string" }, "param7" : { "type" : "string" }, "param8" : { "type" : "string" }, "param9" : { "type" : "string" }, "param10" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "employee" : { "$ref" : "#/components/schemas/Employee" } } }, "SchedulerJobInfo" : { "type" : "object", "properties" : { "job_id" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "job_group" : { "type" : "string" }, "status_id" : { "type" : "integer", "format" : "int64" }, "job_class" : { "type" : "string" }, "cron_expression" : { "type" : "string" }, "description" : { "type" : "string" }, "repeat_time" : { "type" : "integer", "format" : "int32" }, "cron_job" : { "type" : "boolean" }, "time_zone" : { "type" : "string" }, "start_date" : { "type" : "string", "format" : "date-time" }, "end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "emp_id" : { "type" : "integer", "format" : "int64" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "parameters" : { "type" : "string" }, "jobInfo" : { "$ref" : "#/components/schemas/JobDetailsInfo" }, "schedulerJobStatus" : { "$ref" : "#/components/schemas/SchedulerJobStatus" }, "employee" : { "$ref" : "#/components/schemas/Employee" } } }, "SchedulerJobStatus" : { "type" : "object", "properties" : { "status_id" : { "type" : "integer", "format" : "int64" }, "code" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "schedulerJobsInfo" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/SchedulerJobInfo" } } } }, "State" : { "type" : "object", "properties" : { "stateid" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "abbrev" : { "type" : "string" }, "countryid" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "locations" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Location" } }, "country" : { "$ref" : "#/components/schemas/Country" } } }, "Status" : { "type" : "object", "properties" : { "status_id" : { "type" : "integer", "format" : "int64" }, "code" : { "type" : "string" }, "description" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "employeeMessages" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/EmployeeMessage" } } } }, "StorageVolume" : { "type" : "object", "properties" : { "volume_id" : { "type" : "integer", "format" : "int64" }, "application_id" : { "type" : "integer", "format" : "int64" }, "path" : { "type" : "string" }, "protocol" : { "type" : "string" }, "active" : { "type" : "boolean" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "application" : { "$ref" : "#/components/schemas/Application" }, "attachments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Attachment" } } } }, "SupervisorGroup" : { "type" : "object", "properties" : { "supgroup_id" : { "type" : "integer", "format" : "int64" }, "sup_group_code" : { "type" : "string" }, "district_code" : { "type" : "integer", "format" : "int64" }, "district_name" : { "type" : "string" }, "region" : { "type" : "string" }, "status" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "dist" : { "$ref" : "#/components/schemas/District" }, "employees" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Employee" } }, "employeesOnLoan" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/EmployeeOnLoan" } }, "employeesActiveNoAsset" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/EmployeesActiveNoAsset" } }, "assets" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Asset" } } } }, "UserDataAccesses" : { "type" : "object", "properties" : { "user_data_access_id" : { "type" : "integer", "format" : "int64" }, "application_id" : { "type" : "integer", "format" : "int64" }, "emp_id" : { "type" : "integer", "format" : "int64" }, "district_id" : { "type" : "integer", "format" : "int64" }, "sup_group_code" : { "type" : "string" }, "effective_start_date" : { "type" : "string", "format" : "date-time" }, "effective_end_date" : { "type" : "string", "format" : "date-time" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "all_districts" : { "type" : "boolean" }, "all_supgroups" : { "type" : "boolean" }, "attribute1" : { "type" : "string" }, "attribute2" : { "type" : "string" }, "attribute3" : { "type" : "string" }, "attribute4" : { "type" : "string" }, "attribute5" : { "type" : "string" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "application" : { "$ref" : "#/components/schemas/Application" }, "dist" : { "$ref" : "#/components/schemas/District" } } }, "UtilitiesProfilesView" : { "type" : "object", "properties" : { "util_profile_key" : { "$ref" : "#/components/schemas/UtilityProfilePK" }, "facility_type" : { "type" : "string" }, "facility_type_id" : { "type" : "integer", "format" : "int64" }, "utility_type" : { "type" : "string" }, "utility_type_id" : { "type" : "integer", "format" : "int64" }, "facility" : { "type" : "string" }, "facility_id" : { "type" : "integer", "format" : "int64" } } }, "UtilityProfilePK" : { "type" : "object", "properties" : { "facility_type_id" : { "type" : "integer", "format" : "int64" }, "utility_type_id" : { "type" : "integer", "format" : "int64" }, "facility_id" : { "type" : "integer", "format" : "int64" } } }, "Vehicle" : { "type" : "object", "properties" : { "cvn" : { "type" : "string" }, "dvn" : { "type" : "string" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "model_year" : { "type" : "integer", "format" : "int32" }, "make" : { "type" : "string" }, "model_group" : { "type" : "string" }, "vin_number" : { "type" : "string" }, "book_value" : { "type" : "number", "format" : "double" }, "license_plate_number" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "employeeOnLoan" : { "$ref" : "#/components/schemas/EmployeeOnLoan" }, "employeesActiveMultipleItAssets" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssets" }, "employeesActiveNoAsset" : { "$ref" : "#/components/schemas/EmployeesActiveNoAsset" } } }, "Vote" : { "type" : "object", "properties" : { "vote_id" : { "type" : "integer", "format" : "int64" }, "vote_type" : { "type" : "string" }, "idea_id" : { "type" : "integer", "format" : "int64" }, "voter_id" : { "type" : "integer", "format" : "int64" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "idea" : { "$ref" : "#/components/schemas/Idea" }, "employee" : { "$ref" : "#/components/schemas/Employee" } } }, "WfNotification" : { "type" : "object", "properties" : { "notification_id" : { "type" : "integer", "format" : "int64" }, "process_id" : { "type" : "integer", "format" : "int64" }, "activity_id" : { "type" : "integer", "format" : "int64" }, "step_id" : { "type" : "integer", "format" : "int64" }, "status_id" : { "type" : "integer", "format" : "int64" }, "idType" : { "type" : "string" }, "id_column_table" : { "type" : "string" }, "owner" : { "type" : "integer", "format" : "int64" }, "activity_name" : { "type" : "string" }, "text" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "next_step_url" : { "type" : "string" }, "idvalue" : { "type" : "integer", "format" : "int32" }, "completed_date" : { "type" : "string", "format" : "date-time" }, "result" : { "type" : "string" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "remarks" : { "type" : "string" }, "wfNotificationsArchives" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/WfNotificationsArchive" } }, "policyDropOffEstimates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyDropOffEstimate" } } } }, "WfNotificationsArchive" : { "type" : "object", "properties" : { "notification_archive_id" : { "type" : "integer", "format" : "int64" }, "notification_id" : { "type" : "integer", "format" : "int64" }, "process_id" : { "type" : "integer", "format" : "int64" }, "activity_id" : { "type" : "integer", "format" : "int64" }, "step_id" : { "type" : "integer", "format" : "int64" }, "status_id" : { "type" : "integer", "format" : "int64" }, "idType" : { "type" : "string" }, "id_column_table" : { "type" : "string" }, "owner" : { "type" : "integer", "format" : "int64" }, "activity_name" : { "type" : "string" }, "text" : { "type" : "string" }, "created_on" : { "type" : "string", "format" : "date-time" }, "created_by" : { "type" : "string" }, "last_updated_on" : { "type" : "string", "format" : "date-time" }, "last_updated_by" : { "type" : "string" }, "next_step_url" : { "type" : "string" }, "idvalue" : { "type" : "integer", "format" : "int32" }, "completed_date" : { "type" : "string", "format" : "date-time" }, "result" : { "type" : "string" }, "wf_item_id" : { "type" : "integer", "format" : "int64" }, "remarks" : { "type" : "string" }, "archive_date" : { "type" : "string", "format" : "date-time" }, "wfNotification" : { "$ref" : "#/components/schemas/WfNotification" } } }, "WirelessInventory" : { "type" : "object", "properties" : { "wireless_inventory_id" : { "type" : "string" }, "wireless_number" : { "type" : "string" }, "wireless_vendor" : { "type" : "string" }, "wireless_user_full_name" : { "type" : "string" }, "wireless_user_status" : { "type" : "string" }, "district_id" : { "type" : "integer", "format" : "int64" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "truck_vin" : { "type" : "string" }, "imei" : { "type" : "string" }, "sim_number" : { "type" : "string" }, "device_model" : { "type" : "string" }, "contract_end_date" : { "type" : "string", "format" : "date" }, "data_usage" : { "type" : "string" }, "voice_usage" : { "type" : "string" }, "text_usage" : { "type" : "string" }, "total_charges" : { "type" : "integer", "format" : "int32" }, "device_last_updated_on" : { "type" : "string", "format" : "date" }, "usage_last_updated_on" : { "type" : "string", "format" : "date" }, "dist" : { "$ref" : "#/components/schemas/District" }, "employee" : { "$ref" : "#/components/schemas/Employee" }, "employeeOnLoan" : { "$ref" : "#/components/schemas/EmployeeOnLoan" } } }, "WirelessRequest" : { "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary" }, "requestType" : { "type" : "string" }, "reason" : { "type" : "string" }, "wireless_vendor" : { "type" : "string" } } }, "WebAsyncTaskResponseEntityListWirelessResponse" : { "type" : "object", "properties" : { "callable" : { "type" : "object" }, "timeout" : { "type" : "integer", "format" : "int64" }, "executor" : { "$ref" : "#/components/schemas/AsyncTaskExecutor" }, "beanFactory" : { "$ref" : "#/components/schemas/BeanFactory" } } }, "AttMessageHeader" : { "type" : "object", "properties" : { "agreementId" : { "type" : "string" }, "wirelessNumber" : { "type" : "string" }, "accountGroup" : { "type" : "string" }, "accountType" : { "type" : "string" }, "imei" : { "type" : "string" }, "reportType" : { "type" : "string" }, "fromDate" : { "type" : "string" }, "toDate" : { "type" : "string" }, "account_group_id" : { "type" : "string" }, "account_level_value" : { "type" : "string" } } }, "UsicSoapResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "status" : { "type" : "string" }, "description" : { "type" : "string" } } }, "ReqRepResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "statusCode" : { "type" : "string" }, "statusDescription" : { "type" : "string" }, "requestReport" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } } }, "AttCareOrderRequest" : { "type" : "object", "properties" : { "messageHeader" : { "$ref" : "#/components/schemas/AttMessageHeader" }, "ctn" : { "type" : "string" }, "fileName" : { "type" : "string" }, "foundationAccountNumber" : { "type" : "string" }, "orderContactEmail" : { "type" : "string" }, "orderContactFirstName" : { "type" : "string" }, "orderContactLastName" : { "type" : "string" }, "orderContactPhoneNumber" : { "type" : "string" }, "orderContactPhoneNumberExt" : { "type" : "string" }, "payloadId" : { "type" : "string" }, "poNumber" : { "type" : "string" }, "isValid" : { "type" : "boolean" }, "changeRequestList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AttChangeRequest" } } } }, "AttChangeRequest" : { "type" : "object", "properties" : { "billingAddressIndicator" : { "type" : "string" }, "billingAddressLine1" : { "type" : "string" }, "billingAddressLine2" : { "type" : "string" }, "billingAttentionTo" : { "type" : "string" }, "billingCity" : { "type" : "string" }, "billingFirstName" : { "type" : "string" }, "billingLastName" : { "type" : "string" }, "billingPhoneNumber" : { "type" : "string" }, "billingState" : { "type" : "string" }, "billingZipCode" : { "type" : "string" }, "cancelEffectiveDate" : { "type" : "string" }, "cancellationReason" : { "type" : "string" }, "cancelServiceReason" : { "type" : "string" }, "changeRequestId" : { "type" : "string" }, "ctn" : { "type" : "string" }, "deviceICCID" : { "type" : "string" }, "deviceIMEI" : { "type" : "string" }, "deviceNetworkBlock" : { "type" : "string" }, "effectiveDate" : { "type" : "string" }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AttChangeRequestItems" } }, "replaceConflictingFeatures" : { "type" : "string" }, "replaceDuplicateFeatures" : { "type" : "string" }, "resetVoiceMail" : { "$ref" : "#/components/schemas/ResetVoiceMail" }, "resumeServiceReason" : { "type" : "string" }, "subscriberAddressLine1" : { "type" : "string" }, "subscriberAddressLine2" : { "type" : "string" }, "subscriberCity" : { "type" : "string" }, "subscriberFirstName" : { "type" : "string" }, "subscriberLastName" : { "type" : "string" }, "subscriberPhoneNumber" : { "type" : "string" }, "subscriberPhoneNumberExt" : { "type" : "string" }, "subscriberState" : { "type" : "string" }, "subscriberZipCode" : { "type" : "string" }, "suspensionReason" : { "type" : "string" }, "type" : { "type" : "string" }, "udl" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/UDL" } } } }, "AttChangeRequestItems" : { "type" : "object", "properties" : { "itemAction" : { "type" : "string" }, "itemId" : { "type" : "string" }, "effectiveDate" : { "type" : "string" }, "expirationDate" : { "type" : "string" } } }, "ResetVoiceMail" : { "type" : "object", "properties" : { "autogeneratedPIN" : { "type" : "string" }, "pin" : { "type" : "integer" } } }, "UDL" : { "type" : "object", "properties" : { "type" : { "type" : "string" }, "value" : { "type" : "string" } } }, "WirelessResponse" : { "type" : "object", "properties" : { "wirelessNumber" : { "type" : "string" }, "status" : { "type" : "string" }, "description" : { "type" : "string" } } }, "AccessOptions" : { "type" : "object", "properties" : { "isDefault" : { "$ref" : "#/components/schemas/JAXBElementString" }, "name" : { "$ref" : "#/components/schemas/JAXBElementString" }, "price" : { "$ref" : "#/components/schemas/JAXBElementString" }, "type" : { "$ref" : "#/components/schemas/JAXBElementString" } } }, "CareOrderResponse2" : { "type" : "object", "properties" : { "accessOptions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JAXBElementAccessOptions" } }, "billingAccountName" : { "$ref" : "#/components/schemas/JAXBElementString" }, "billingAccountNumber" : { "$ref" : "#/components/schemas/JAXBElementString" }, "billingAddressLine1" : { "$ref" : "#/components/schemas/JAXBElementString" }, "billingAttentionTo" : { "$ref" : "#/components/schemas/JAXBElementString" }, "billingCity" : { "$ref" : "#/components/schemas/JAXBElementString" }, "billingContactEmail" : { "$ref" : "#/components/schemas/JAXBElementString" }, "billingContactName" : { "$ref" : "#/components/schemas/JAXBElementString" }, "billingContactPhoneNumber" : { "$ref" : "#/components/schemas/JAXBElementString" }, "billingState" : { "$ref" : "#/components/schemas/JAXBElementString" }, "billingZipCode" : { "$ref" : "#/components/schemas/JAXBElementString" }, "cancelledDate" : { "$ref" : "#/components/schemas/JAXBElementXMLGregorianCalendar" }, "contractEndDate" : { "$ref" : "#/components/schemas/JAXBElementXMLGregorianCalendar" }, "contractStartDate" : { "$ref" : "#/components/schemas/JAXBElementXMLGregorianCalendar" }, "deviceICCID" : { "$ref" : "#/components/schemas/JAXBElementString" }, "deviceMake" : { "$ref" : "#/components/schemas/JAXBElementString" }, "deviceModel" : { "$ref" : "#/components/schemas/JAXBElementString" }, "deviceMPN" : { "$ref" : "#/components/schemas/JAXBElementString" }, "deviceIMEI" : { "$ref" : "#/components/schemas/JAXBElementString" }, "deviceSKUID" : { "$ref" : "#/components/schemas/JAXBElementString" }, "discount" : { "$ref" : "#/components/schemas/JAXBElementString" }, "enterpriseInstallmentPlan" : { "$ref" : "#/components/schemas/JAXBElementEnterpriseInstallmentPlan" }, "feature" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JAXBElementFeature" } }, "foundationAccountName" : { "$ref" : "#/components/schemas/JAXBElementString" }, "foundationAccountNumber" : { "$ref" : "#/components/schemas/JAXBElementString" }, "payloadId" : { "$ref" : "#/components/schemas/JAXBElementString" }, "ratePlanEffectiveDate" : { "$ref" : "#/components/schemas/JAXBElementXMLGregorianCalendar" }, "ratePlanExpirationDate" : { "$ref" : "#/components/schemas/JAXBElementXMLGregorianCalendar" }, "ratePlanIncludedFeature" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JAXBElementString" } }, "ratePlanName" : { "$ref" : "#/components/schemas/JAXBElementString" }, "ratePlanPrice" : { "$ref" : "#/components/schemas/JAXBElementString" }, "ratePlanSKUID" : { "$ref" : "#/components/schemas/JAXBElementString" }, "ratePlanSOC" : { "$ref" : "#/components/schemas/JAXBElementString" }, "requestId" : { "$ref" : "#/components/schemas/JAXBElementString" }, "requestSubmitter" : { "$ref" : "#/components/schemas/JAXBElementString" }, "requestType" : { "$ref" : "#/components/schemas/JAXBElementString" }, "statusCode" : { "$ref" : "#/components/schemas/JAXBElementString" }, "statusDescription" : { "$ref" : "#/components/schemas/JAXBElementString" }, "subscriberPPUAddressCity" : { "$ref" : "#/components/schemas/JAXBElementString" }, "subscriberPPUAddressLine1" : { "$ref" : "#/components/schemas/JAXBElementString" }, "subscriberPPUAddressLine2" : { "$ref" : "#/components/schemas/JAXBElementString" }, "subscriberPPUAddressState" : { "$ref" : "#/components/schemas/JAXBElementString" }, "subscriberPPUAddressZip" : { "$ref" : "#/components/schemas/JAXBElementString" }, "suspendedDate" : { "$ref" : "#/components/schemas/JAXBElementXMLGregorianCalendar" }, "wirelessUserName" : { "$ref" : "#/components/schemas/JAXBElementString" }, "wirelessNumber" : { "$ref" : "#/components/schemas/JAXBElementString" }, "udlinfo" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/JAXBElementUDLInfo" } } }, "xml" : { "name" : "CareOrderResponse", "namespace" : "http://b2b.att.com/schema/OrderingMobility/v8_0" } }, "EnterpriseInstallmentPlan" : { "type" : "object", "properties" : { "agreementDate" : { "$ref" : "#/components/schemas/JAXBElementXMLGregorianCalendar" }, "earlyPayOffAmount" : { "$ref" : "#/components/schemas/JAXBElementDouble" }, "installmentPlanId" : { "$ref" : "#/components/schemas/JAXBElementString" }, "installmentPlanTotal" : { "$ref" : "#/components/schemas/JAXBElementString" }, "monthlyInstallment" : { "$ref" : "#/components/schemas/JAXBElementString" }, "paidToDate" : { "$ref" : "#/components/schemas/JAXBElementDouble" }, "pendingInstallments" : { "$ref" : "#/components/schemas/JAXBElementString" }, "totalTerm" : { "$ref" : "#/components/schemas/JAXBElementString" } } }, "Feature" : { "type" : "object", "properties" : { "name" : { "$ref" : "#/components/schemas/JAXBElementString" }, "price" : { "$ref" : "#/components/schemas/JAXBElementString" }, "effectiveDate" : { "$ref" : "#/components/schemas/JAXBElementXMLGregorianCalendar" }, "expirationDate" : { "$ref" : "#/components/schemas/JAXBElementXMLGregorianCalendar" }, "skuid" : { "$ref" : "#/components/schemas/JAXBElementString" }, "soc" : { "$ref" : "#/components/schemas/JAXBElementString" } } }, "JAXBElementAccessOptions" : { "type" : "object", "properties" : { "name" : { "type" : "object", "properties" : { "namespaceURI" : { "type" : "string" }, "localPart" : { "type" : "string" }, "prefix" : { "type" : "string" } } }, "value" : { "$ref" : "#/components/schemas/AccessOptions" }, "nil" : { "type" : "boolean" }, "typeSubstituted" : { "type" : "boolean" }, "globalScope" : { "type" : "boolean" } } }, "JAXBElementDouble" : { "type" : "object", "properties" : { "name" : { "type" : "object", "properties" : { "namespaceURI" : { "type" : "string" }, "localPart" : { "type" : "string" }, "prefix" : { "type" : "string" } } }, "value" : { "type" : "number", "format" : "double" }, "nil" : { "type" : "boolean" }, "typeSubstituted" : { "type" : "boolean" }, "globalScope" : { "type" : "boolean" } } }, "JAXBElementEnterpriseInstallmentPlan" : { "type" : "object", "properties" : { "name" : { "type" : "object", "properties" : { "namespaceURI" : { "type" : "string" }, "localPart" : { "type" : "string" }, "prefix" : { "type" : "string" } } }, "value" : { "$ref" : "#/components/schemas/EnterpriseInstallmentPlan" }, "nil" : { "type" : "boolean" }, "typeSubstituted" : { "type" : "boolean" }, "globalScope" : { "type" : "boolean" } } }, "JAXBElementFeature" : { "type" : "object", "properties" : { "name" : { "type" : "object", "properties" : { "namespaceURI" : { "type" : "string" }, "localPart" : { "type" : "string" }, "prefix" : { "type" : "string" } } }, "value" : { "$ref" : "#/components/schemas/Feature" }, "nil" : { "type" : "boolean" }, "typeSubstituted" : { "type" : "boolean" }, "globalScope" : { "type" : "boolean" } } }, "JAXBElementUDLInfo" : { "type" : "object", "properties" : { "name" : { "type" : "object", "properties" : { "namespaceURI" : { "type" : "string" }, "localPart" : { "type" : "string" }, "prefix" : { "type" : "string" } } }, "value" : { "$ref" : "#/components/schemas/UDLInfo" }, "nil" : { "type" : "boolean" }, "typeSubstituted" : { "type" : "boolean" }, "globalScope" : { "type" : "boolean" } } }, "JAXBElementXMLGregorianCalendar" : { "type" : "object", "properties" : { "name" : { "type" : "object", "properties" : { "namespaceURI" : { "type" : "string" }, "localPart" : { "type" : "string" }, "prefix" : { "type" : "string" } } }, "value" : { "type" : "string", "format" : "date-time" }, "nil" : { "type" : "boolean" }, "typeSubstituted" : { "type" : "boolean" }, "globalScope" : { "type" : "boolean" } } }, "UDLInfo" : { "type" : "object", "properties" : { "type" : { "$ref" : "#/components/schemas/JAXBElementString" }, "value" : { "$ref" : "#/components/schemas/JAXBElementString" } } }, "TransloreRequest" : { "type" : "object", "properties" : { "manufacturer" : { "type" : "string" }, "model_number" : { "type" : "string" }, "serial_number" : { "type" : "string" }, "alt_serial_number" : { "type" : "string" }, "employee_id" : { "type" : "integer", "format" : "int64" }, "created_at" : { "type" : "string", "format" : "date-time" }, "supgroup_code" : { "type" : "string" }, "district_code" : { "type" : "integer", "format" : "int64" }, "locate_id" : { "type" : "integer", "format" : "int64" }, "lat" : { "type" : "string" }, "lon" : { "type" : "string" } } }, "BulkRequest" : { "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary" }, "mapping_id" : { "type" : "integer", "format" : "int32" }, "model_id" : { "type" : "integer", "format" : "int32" }, "district_id" : { "type" : "integer", "format" : "int32" }, "supgroup_code" : { "type" : "string" }, "location_id" : { "type" : "integer", "format" : "int32" }, "purchase_price" : { "type" : "number", "format" : "double" }, "purchase_date" : { "type" : "string", "format" : "date-time" } } }, "WebAsyncTaskResponseEntityObject" : { "type" : "object", "properties" : { "callable" : { "type" : "object" }, "timeout" : { "type" : "integer", "format" : "int64" }, "executor" : { "$ref" : "#/components/schemas/AsyncTaskExecutor" }, "beanFactory" : { "$ref" : "#/components/schemas/BeanFactory" } } }, "BulkAssignmentRequest" : { "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary" }, "assetId" : { "type" : "integer", "format" : "int32" }, "employeeId" : { "type" : "integer", "format" : "int32" }, "districtId" : { "type" : "integer", "format" : "int32" }, "trackingNo" : { "type" : "string" } } }, "JsonApiDocumentJsonApiResourceMapStringObject" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/JsonApiResourceMapStringObject" } } }, "JsonApiResourceMapStringObject" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string" }, "attributes" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "BinderSummary" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "documents" : { "type" : "integer", "format" : "int64" }, "pages" : { "type" : "integer", "format" : "int64" } } }, "CitedPage" : { "type" : "object", "properties" : { "documentId" : { "type" : "integer", "format" : "int64" }, "documentTitle" : { "type" : "string" }, "pageNumber" : { "type" : "integer", "format" : "int32" }, "quotedText" : { "type" : "string" } } }, "FeedbackExportRow" : { "type" : "object", "properties" : { "requestId" : { "type" : "string" }, "askedAt" : { "type" : "string", "format" : "date-time" }, "userId" : { "type" : "string" }, "district" : { "type" : "string" }, "binder" : { "type" : "string" }, "question" : { "type" : "string" }, "status" : { "type" : "string" }, "reason" : { "type" : "string" }, "answerText" : { "type" : "string" }, "closestTopic" : { "type" : "string" }, "citations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CitedPage" } }, "verdict" : { "type" : "string", "enum" : [ "CORRECT", "INCORRECT", "UNCLEAR" ] }, "note" : { "type" : "string" }, "feedbackUserId" : { "type" : "string" }, "feedbackAt" : { "type" : "string", "format" : "date-time" } } }, "AssignedOwner" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "uid" : { "type" : "string" }, "firstName" : { "type" : "string" }, "lastName" : { "type" : "string" }, "email" : { "type" : "string" }, "phone" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "administrator" : { "type" : "boolean" }, "permitAllClients" : { "type" : "boolean" }, "notifyAllClients" : { "type" : "boolean" }, "mustChangePw" : { "type" : "boolean" }, "mfaConfigured" : { "type" : "boolean" }, "userType" : { "type" : "string" }, "invitationStatus" : { "type" : "string" }, "organizationId" : { "type" : "integer", "format" : "int32" }, "deviceIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "assignedDeviceIds" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "fields" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "roles" : { "type" : "array", "items" : { "type" : "string" } } } }, "BackupUsage" : { "type" : "object", "properties" : { "revisionsCurrentSize" : { "type" : "integer", "format" : "int64" }, "revisionsPreviousSize" : { "type" : "integer", "format" : "int64" }, "revisionsDeletedSize" : { "type" : "integer", "format" : "int64" }, "localFileFolderSize" : { "type" : "integer", "format" : "int64" }, "localImageSize" : { "type" : "integer", "format" : "int64" }, "localImageV2Size" : { "type" : "integer", "format" : "int64" }, "cloudFileFolderSize" : { "type" : "integer", "format" : "int64" }, "cloudImageSize" : { "type" : "integer", "format" : "int64" }, "cloudImageV2Size" : { "type" : "integer", "format" : "int64" }, "lastSuccessfulBackupJob" : { "type" : "integer", "format" : "int64" }, "lastFailedBackupJob" : { "type" : "integer", "format" : "int64" }, "revisionsTotalSize" : { "type" : "integer", "format" : "int64" }, "cloudTotalSize" : { "type" : "integer", "format" : "int64" }, "localTotalSize" : { "type" : "integer", "format" : "int64" } } }, "DeviceNinjaOne" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "uid" : { "type" : "string" }, "assignedOwnerUid" : { "type" : "string" }, "parentDeviceId" : { "type" : "integer", "format" : "int32" }, "organizationId" : { "type" : "integer", "format" : "int32" }, "locationId" : { "type" : "integer", "format" : "int32" }, "nodeClass" : { "type" : "string" }, "nodeRoleId" : { "type" : "integer", "format" : "int32" }, "rolePolicyId" : { "type" : "integer", "format" : "int32" }, "policyId" : { "type" : "integer", "format" : "int32" }, "approvalStatus" : { "type" : "string" }, "offline" : { "type" : "boolean" }, "displayName" : { "type" : "string" }, "systemName" : { "type" : "string" }, "dnsName" : { "type" : "string" }, "netbiosName" : { "type" : "string" }, "created" : { "type" : "integer", "format" : "int64" }, "lastContact" : { "type" : "integer", "format" : "int64" }, "lastUpdate" : { "type" : "integer", "format" : "int64" }, "userData" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "fields" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "maintenance" : { "$ref" : "#/components/schemas/Maintenance" }, "references" : { "$ref" : "#/components/schemas/References" }, "ipAddresses" : { "type" : "array", "items" : { "type" : "string" } }, "macAddresses" : { "type" : "array", "items" : { "type" : "string" } }, "publicIP" : { "type" : "string" }, "notes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Note" } }, "deviceType" : { "type" : "string" }, "os" : { "$ref" : "#/components/schemas/OS" }, "system" : { "$ref" : "#/components/schemas/System" }, "memory" : { "$ref" : "#/components/schemas/Memory" }, "processors" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Processor" } }, "volumes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Volume" } }, "lastLoggedInUser" : { "type" : "string" } } }, "Maintenance" : { "type" : "object", "properties" : { "status" : { "type" : "string" }, "start" : { "type" : "integer", "format" : "int64" }, "end" : { "type" : "integer", "format" : "int64" } } }, "Memory" : { "type" : "object", "properties" : { "capacity" : { "type" : "integer", "format" : "int64" } } }, "Note" : { "type" : "object", "properties" : { "text" : { "type" : "string" } } }, "OS" : { "type" : "object", "properties" : { "manufacturer" : { "type" : "string" }, "name" : { "type" : "string" }, "architecture" : { "type" : "string" }, "lastBootTime" : { "type" : "integer", "format" : "int64" }, "buildNumber" : { "type" : "string" }, "releaseId" : { "type" : "string" }, "servicePackMajorVersion" : { "type" : "integer", "format" : "int32" }, "servicePackMinorVersion" : { "type" : "integer", "format" : "int32" }, "locale" : { "type" : "string" }, "language" : { "type" : "string" }, "needsReboot" : { "type" : "boolean" } } }, "Organization" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "description" : { "type" : "string" }, "userData" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "nodeApprovalMode" : { "type" : "string" }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "fields" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "id" : { "type" : "integer", "format" : "int32" } } }, "Policy" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "parentPolicyId" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "nodeClass" : { "type" : "string" }, "updated" : { "type" : "integer", "format" : "int64" }, "nodeClassDefault" : { "type" : "boolean" }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "fields" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "Processor" : { "type" : "object", "properties" : { "architecture" : { "type" : "string" }, "maxClockSpeed" : { "type" : "integer", "format" : "int64" }, "clockSpeed" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string" }, "numCores" : { "type" : "integer", "format" : "int32" }, "numLogicalCores" : { "type" : "integer", "format" : "int32" } } }, "References" : { "type" : "object", "properties" : { "organization" : { "$ref" : "#/components/schemas/Organization" }, "location" : { "$ref" : "#/components/schemas/Location" }, "rolePolicy" : { "$ref" : "#/components/schemas/Policy" }, "policy" : { "$ref" : "#/components/schemas/Policy" }, "role" : { "$ref" : "#/components/schemas/Role" }, "backupUsage" : { "$ref" : "#/components/schemas/BackupUsage" }, "warranty" : { "$ref" : "#/components/schemas/Warranty" }, "assignedOwner" : { "$ref" : "#/components/schemas/AssignedOwner" } } }, "Role" : { "type" : "object", "properties" : { "id" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "description" : { "type" : "string" }, "nodeClass" : { "type" : "string" }, "custom" : { "type" : "boolean" }, "chassisType" : { "type" : "string" }, "created" : { "type" : "integer", "format" : "int64" }, "tags" : { "type" : "array", "items" : { "type" : "string" } }, "fields" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "nodeRoleParentId" : { "type" : "integer", "format" : "int32" }, "icon" : { "type" : "string" } } }, "System" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "manufacturer" : { "type" : "string" }, "model" : { "type" : "string" }, "biosSerialNumber" : { "type" : "string" }, "serialNumber" : { "type" : "string" }, "domain" : { "type" : "string" }, "domainRole" : { "type" : "string" }, "numberOfProcessors" : { "type" : "integer", "format" : "int32" }, "totalPhysicalMemory" : { "type" : "integer", "format" : "int64" }, "virtualMachine" : { "type" : "boolean" }, "chassisType" : { "type" : "string" } } }, "Volume" : { "type" : "object", "properties" : { "nodeId" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "label" : { "type" : "string" }, "deviceType" : { "type" : "string" }, "fileSystem" : { "type" : "string" }, "autoMount" : { "type" : "boolean" }, "compressed" : { "type" : "boolean" }, "capacity" : { "type" : "integer", "format" : "int64" }, "freeSpace" : { "type" : "integer", "format" : "int64" }, "serialNumber" : { "type" : "string" } } }, "Warranty" : { "type" : "object", "properties" : { "startDate" : { "type" : "integer", "format" : "int64" }, "endDate" : { "type" : "integer", "format" : "int64" }, "manufacturerFulfillmentDate" : { "type" : "integer", "format" : "int64" } } }, "JsonApiDocumentJsonApiResourceTpHistoryAttributes" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/JsonApiResourceTpHistoryAttributes" } } }, "JsonApiResourceTpHistoryAttributes" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "type" : { "type" : "string" }, "attributes" : { "$ref" : "#/components/schemas/TpHistoryAttributes" } } }, "TpHistoryAttributes" : { "type" : "object", "properties" : { "events" : { "type" : "string" } } }, "ReceivedTicketsYearResponse" : { "type" : "object", "properties" : { "parse_MONTH" : { "type" : "integer", "format" : "int32" }, "month" : { "type" : "string" }, "ticket_COUNT_YEAR" : { "type" : "integer", "format" : "int64" }, "parse_YEAR" : { "type" : "integer", "format" : "int32" } } }, "ReceivedTicketsWeekResponse" : { "type" : "object", "properties" : { "ticket_COUNT_WEEK" : { "type" : "integer", "format" : "int32" }, "xaxis" : { "type" : "string" } } }, "LoginsByAccountYearlyResponse" : { "type" : "object", "properties" : { "accountName" : { "type" : "string" }, "logins" : { "type" : "integer", "format" : "int32" } } }, "LoginsByAccountUserYearlyResponse" : { "type" : "object", "properties" : { "accountName" : { "type" : "string" }, "userName" : { "type" : "string" }, "logins" : { "type" : "integer", "format" : "int32" } } }, "LoginsByAccountUserMonthlyResponse" : { "type" : "object", "properties" : { "accountName" : { "type" : "string" }, "userName" : { "type" : "string" }, "logins" : { "type" : "integer", "format" : "int32" } } }, "LoginsByAccountMonthlyResponse" : { "type" : "object", "properties" : { "accountName" : { "type" : "string" }, "logins" : { "type" : "integer", "format" : "int32" } } }, "AssetResponse" : { "type" : "object", "properties" : { "asset_id" : { "type" : "integer", "format" : "int64" }, "version_number" : { "type" : "integer", "format" : "int32" }, "mapping_id" : { "type" : "integer", "format" : "int64" }, "model_id" : { "type" : "integer", "format" : "int64" }, "serial_number" : { "type" : "string" }, "usic_tag" : { "type" : "string" }, "status_id" : { "type" : "integer", "format" : "int64" }, "make_id" : { "type" : "integer", "format" : "int64" }, "description" : { "type" : "integer", "format" : "int64", "writeOnly" : true } } } }, "responses" : { "400" : { "description" : "BAD_REQUEST", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "401" : { "description" : "UNAUTHORIZED", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "403" : { "description" : "FORBIDDEN", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "404" : { "description" : "NOT_FOUND", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "405" : { "description" : "METHOD_NOT_ALLOWED", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "409" : { "description" : "CONFLICT", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "412" : { "description" : "PRECONDITION_FAILED", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "415" : { "description" : "UNSUPPORTED_MEDIA_TYPE", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "422" : { "description" : "UNPROCESSABLE_ENTITY", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "500" : { "description" : "INTERNAL_SERVER_ERROR", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "501" : { "description" : "NOT_IMPLEMENTED", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "502" : { "description" : "BAD_GATEWAY", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "503" : { "description" : "SERVICE_UNAVAILABLE", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "504" : { "description" : "GATEWAY_TIMEOUT", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "505" : { "description" : "HTTP_VERSION_NOT_SUPPORTED", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/Failure", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "NoContent" : { "description" : "No Content" }, "AccrualSummariesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AccrualSummariesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualSummariesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AccrualSummariesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualSummariesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AccrualSummariesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualSummariesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AccrualsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AccrualsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AccrualsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AccrualsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AccrualsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ActivitiesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ActivitiesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivitiesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ActivitiesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ActivitiesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivitiesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ActivityPathPointsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ActivityPathPointsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ActivityPathPointsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivityPathPointsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ActivityPathPointsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ActivityPathPointsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AnnouncementsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AnnouncementsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AnnouncementsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AnnouncementsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AnnouncementsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ApplicationsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ApplicationsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ApplicationsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ApplicationsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ApproverListingsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApproverListingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ApproverListingsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApproverListingsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ApproverListingsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApproverListingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ApproverListingsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ApproverListingsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAssignmentsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAssignmentsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAssignmentsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAssignmentsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAttributeValuesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAttributeValuesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAttributeValuesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAttributeValuesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAttributesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAttributesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAttributesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetAttributesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetAttributesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetCategoriesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetCategoriesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetCategoriesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetCategoriesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoriesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetCategoryTypesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetCategoryTypesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetCategoryTypesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetCategoryTypesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetMakesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetMakesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetMakesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetMakesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetMakesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetModelsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetModelsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetModelsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetModelsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetModelsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetStatusesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetStatusesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetStatusesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetStatusesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetStatusesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTrackMaintenancesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTrackMaintenancesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTrackMaintenancesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTrackMaintenancesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTransferExceptionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTransferExceptionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTransferExceptionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTransferExceptionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTransferExceptionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTransferExceptionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTypesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTypesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTypesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetTypesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetTypesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AssetsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AssetsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttAccountsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttAccountsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttAccountsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttAccountsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttAccountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttAccountsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttAccountsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttProductCatalogItemsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttProductCatalogItemsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttProductCatalogItemsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttProductCatalogItemsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttProductCatalogItemsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttProductCatalogItemsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttWirelessInventoriesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttWirelessInventoriesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttWirelessInventoriesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttWirelessInventoriesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoriesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttWirelessInventoryUsagesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttWirelessInventoryUsagesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttWirelessInventoryUsagesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttWirelessInventoryUsagesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachEntitiesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachEntitiesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachEntitiesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachEntitiesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachEntitiesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentEntitiesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentEntitiesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentEntitiesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentEntitiesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentsCategorizedResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentsCategorizedResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentsCategorizedResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentsCategorizedResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsCategorizedResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentsWithNotificationsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentsWithNotificationsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentsWithNotificationsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttachmentsWithNotificationsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttributeMappingsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttributeMappingsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttributeMappingsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttributeMappingsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttributeMappingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "AttributeMappingsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/AttributeMappingsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "BillableCustomersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BillableCustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "BillableCustomersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BillableCustomersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "BillableCustomersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BillableCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "BillableCustomersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BillableCustomersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "BucketsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BucketsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "BucketsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BucketsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "BucketsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BucketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "BucketsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/BucketsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CasesSubtypesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesSubtypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CasesSubtypesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesSubtypesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CasesSubtypesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesSubtypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CasesSubtypesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesSubtypesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CasesTypesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CasesTypesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesTypesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CasesTypesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CasesTypesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CasesTypesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CategoryTypeMakeMappingsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CategoryTypeMakeMappingsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CategoryTypeMakeMappingsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CategoryTypeMakeMappingsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ChangeLogsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ChangeLogsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ChangeLogsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ChangeLogsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ChangeLogsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ChangeLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ChangeLogsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ChangeLogsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimAllocationTypesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimAllocationTypesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimAllocationTypesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimAllocationTypesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimAllocationTypesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimCategoriesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimCategoriesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimCategoriesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimCategoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimCategoriesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimCategoriesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimDetailsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimDetailsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDetailsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimDetailsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDetailsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimDetailsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDetailsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimDiscountsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimDiscountsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimDiscountsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDiscountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimDiscountsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimDiscountsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimPayeesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimPayeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimPayeesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimPayeesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimPayeesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimPayeesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimPayeesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimPayeesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimSpendCategoriesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimSpendCategoriesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimSpendCategoriesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimSpendCategoriesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClaimsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClaimsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClosedTicketsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClosedTicketsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClosedTicketsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClosedTicketsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClosedTicketsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClosedTicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ClosedTicketsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ClosedTicketsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsCustomersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsCustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsCustomersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsCustomersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsCustomersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsCustomersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsCustomersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsDistrictsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsDistrictsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsDistrictsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsDistrictsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsDistrictsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsDistrictsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsDistrictsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsDistrictsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsErrorLogsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsErrorLogsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsErrorLogsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsErrorLogsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsErrorLogsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsErrorLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsErrorLogsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsErrorLogsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsInvestigationDetailsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsInvestigationDetailsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsInvestigationDetailsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsInvestigationDetailsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsRequestsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsRequestsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsRequestsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsRequestsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsRequestsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsRequestsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsRequestsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsRequestsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsUserDataAccessesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsUserDataAccessesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsUserDataAccessesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsUserDataAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CmsUserDataAccessesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CmsUserDataAccessesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CommentsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CommentsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CommentsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CommentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CommentsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CommentsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CommentsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CommentsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ContractsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ContractsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ContractsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ContractsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ContractsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CountriesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CountriesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CountriesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CountriesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CountriesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CpDistrictsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpDistrictsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CpDistrictsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpDistrictsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CpDistrictsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpDistrictsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CpDistrictsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpDistrictsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CpstorageVolumesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpstorageVolumesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CpstorageVolumesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpstorageVolumesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CpstorageVolumesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpstorageVolumesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CpstorageVolumesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CpstorageVolumesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountActivitiesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountActivitiesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountActivitiesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountActivitiesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountNotesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountNotesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountNotesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountNotesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerAccountsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerAccountsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractSettingsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractSettingsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractSettingsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractSettingsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractStatesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractStatesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractStatesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractStatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractStatesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractStatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractStatesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractStatesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomerContractsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomerContractsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "CustomersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/CustomersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageCustomersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageCustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageCustomersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageCustomersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageCustomersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageCustomersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageCustomersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageDetailsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageDetailsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageDetailsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageDetailsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageDetailsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageDetailsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageDetailsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageListingsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageListingsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageListingsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageListingsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageListingsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageListingsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamageListingsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamageListingsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamagePhotosResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamagePhotosResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamagePhotosResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamagePhotosResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagePhotosResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamagesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamagesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamagesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DamagesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DamagesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DeletionTypesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DeletionTypesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DeletionTypesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DeletionTypesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeletionTypesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DeviceTokensResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DeviceTokensResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DeviceTokensResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DeviceTokensResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DeviceTokensResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DigAreasResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DigAreasResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DigAreasResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DigAreasResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DigAreasResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DigAreasResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DigAreasResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DigAreasResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictBoundariesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictBoundariesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictBoundariesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictBoundariesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictBoundariesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictBoundariesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictBoundariesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictBoundariesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictLocationsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictLocationsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictLocationsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictLocationsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictLocationsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DistrictsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DistrictsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DueDateExtensionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DueDateExtensionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DueDateExtensionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DueDateExtensionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "DueDateExtensionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/DueDateExtensionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeeMessagesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeeMessagesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeeMessagesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeeMessagesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesActiveMultipleItAssetsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesActiveMultipleItAssetsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesActiveMultipleItAssetsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesActiveMultipleItAssetsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesActiveNoAssetsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesActiveNoAssetsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesActiveNoAssetsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesActiveNoAssetsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesOnLoanResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesOnLoanResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesOnLoanResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesOnLoanResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EmployeesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EmployeesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ErrorLogsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ErrorLogsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ErrorLogsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ErrorLogsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ErrorLogsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ErrorLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ErrorLogsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ErrorLogsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EstimatesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EstimatesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EstimatesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EstimatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EstimatesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EstimatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "EstimatesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/EstimatesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ExcavatorResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ExcavatorResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ExcavatorResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ExcavatorResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ExcavatorResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ExcavatorResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ExcavatorResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ExcavatorResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FacilitiesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FacilitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FacilitiesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FacilitiesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FacilitiesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FacilitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FacilitiesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FacilitiesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FeedsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FeedsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FeedsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FeedsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FeedsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FeedsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FeedsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FeedsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FinancialPeriodsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FinancialPeriodsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FinancialPeriodsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FinancialPeriodsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FinancialPeriodsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FinancialPeriodsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FlatRateCustomersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FlatRateCustomersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FlatRateCustomersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FlatRateCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "FlatRateCustomersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/FlatRateCustomersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "IdeaKindsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeaKindsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "IdeaKindsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeaKindsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "IdeaKindsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeaKindsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "IdeaKindsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeaKindsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "IdeasResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeasResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "IdeasResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeasResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "IdeasResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeasResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "IdeasResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/IdeasResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailLinesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailLinesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailLinesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailLinesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailLinesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailsVersionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailsVersionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailsVersionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationDetailsVersionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationVersionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationVersionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationVersionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationVersionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationVersionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationVersionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "InvestigationsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/InvestigationsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "JournalsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JournalsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "JournalsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JournalsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "JournalsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JournalsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "JournalsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/JournalsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LawFirmsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LawFirmsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LawFirmsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LawFirmsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LawFirmsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LawFirmsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LawFirmsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LawFirmsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalCasesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalCasesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalCasesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalCasesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalCasesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalCasesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalCasesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalCasesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalDamagesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalDamagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalDamagesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalDamagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalDamagesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalDamagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalDamagesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalDamagesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalPartiesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalPartiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalPartiesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalPartiesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalPartiesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalPartiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalPartiesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalPartiesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalRisksResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalRisksResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalRisksResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalRisksResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalRisksResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalRisksResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LegalRisksResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LegalRisksResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LoanedEmployeeAssetsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LoanedEmployeeAssetsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LoanedEmployeeAssetsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LoanedEmployeeAssetsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocateClosedSnapshotsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocateClosedSnapshotsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocateClosedSnapshotsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocateClosedSnapshotsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocateOpenSnapshotsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocateOpenSnapshotsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocateOpenSnapshotsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocateOpenSnapshotsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocatesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocatesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocatesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocatesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocationsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocationsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocationsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocationsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocationsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocatorCheckinsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocatorCheckinsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocatorCheckinsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LocatorCheckinsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LogosResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LogosResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LogosResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LogosResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LogosResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LogosResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "LogosResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/LogosResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MdmDevicesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MdmDevicesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MdmDevicesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MdmDevicesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MdmDevicesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MdmDevicesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MdmDevicesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MdmDevicesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MessagesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MessagesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MessagesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MessagesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MessagesWithCountsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MessagesWithCountsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MessagesWithCountsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesWithCountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "MessagesWithCountsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/MessagesWithCountsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "NetmotionDevicesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "NetmotionDevicesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "NetmotionDevicesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NetmotionDevicesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "NetmotionDevicesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NetmotionDevicesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "NotesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NotesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "NotesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NotesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "NotesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NotesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "NotesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/NotesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "OpenTicketsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OpenTicketsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "OpenTicketsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OpenTicketsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "OpenTicketsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OpenTicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "OpenTicketsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OpenTicketsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "OrganizationsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "OrganizationsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "OrganizationsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "OrganizationsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PasskeyCredentialsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PasskeyCredentialsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PasskeyCredentialsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PasskeyCredentialsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PasskeyUsersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PasskeyUsersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PasskeyUsersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PasskeyUsersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PasskeyUsersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PayeeAddressesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PayeeAddressesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PayeeAddressesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PayeeAddressesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PayeeAddressesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PayeeAddressesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PayeeAddressesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PayeeAddressesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PhotoCompliancesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PhotoCompliancesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PhotoCompliancesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PhotoCompliancesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PhotoCompliancesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PhotoCompliancesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PhotoCompliancesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PhotoCompliancesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PolicyDropOffEstimatesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PolicyDropOffEstimatesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PolicyDropOffEstimatesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PolicyDropOffEstimatesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfileLevelsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfileLevelsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfileLevelsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfileLevelsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileLevelsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfileValuesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileValuesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfileValuesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileValuesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfileValuesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileValuesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfileValuesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfileValuesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfilesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfilesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfilesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProfilesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProfilesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProjectTicketsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProjectTicketsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProjectTicketsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProjectTicketsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProjectTicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ProjectTicketsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ProjectTicketsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PumpDeviceResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDeviceResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PumpDeviceResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDeviceResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PumpDeviceResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDeviceResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PumpDeviceResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDeviceResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PumpDevicesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDevicesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PumpDevicesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDevicesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PumpDevicesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDevicesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "PumpDevicesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/PumpDevicesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionaireAnswersVersionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionaireAnswersVersionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionaireAnswersVersionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionaireAnswersVersionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionnaireAnswersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionnaireAnswersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionnaireAnswersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionnaireAnswersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireAnswersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionnaireQuestionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionnaireQuestionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionnaireQuestionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuestionnaireQuestionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeValueResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeValueResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValueResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeValueResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValueResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeValueResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValueResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeValuesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeValuesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeValuesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValuesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodeValuesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodeValuesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "QuickCodesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/QuickCodesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RandomEmployeePicksResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RandomEmployeePicksResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RandomEmployeePicksResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RandomEmployeePicksResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RandomEmployeePicksResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RandomEmployeePicksResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RandomEmployeePicksResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RandomEmployeePicksResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RepairReasonsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RepairReasonsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RepairReasonsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RepairReasonsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RepairReasonsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportDataTypesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportDataTypesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportDataTypesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportDataTypesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportDataTypesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportDataTypesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportDataTypesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportDataTypesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportGroupSectionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportGroupSectionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportGroupSectionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportGroupSectionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportGroupsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportGroupsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportGroupsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportGroupsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportGroupsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportSourcesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportSourcesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportSourcesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportSourcesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportSourcesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportsSectionOrdersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportsSectionOrdersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportsSectionOrdersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ReportsSectionOrdersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RequestsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RequestsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RequestsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RequestsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RequestsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ResponseLogsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ResponseLogsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ResponseLogsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ResponseLogsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ResponseLogsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ResponseLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ResponseLogsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ResponseLogsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RoleAccessesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleAccessesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RoleAccessesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RoleAccessesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RoleAccessesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleAccessesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RoleActionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RoleActionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RoleActionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "RoleActionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/RoleActionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SchedulerJobStatusesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SchedulerJobStatusesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SchedulerJobStatusesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SchedulerJobStatusesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SchedulerJobsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SchedulerJobsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SchedulerJobsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SchedulerJobsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SchedulerJobsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountLocateMatchesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountLocateMatchesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountLocateMatchesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountLocateMatchesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountRulesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountRulesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountRulesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountRulesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountRulesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ServiceAccountsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ServiceAccountsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SessionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SessionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SessionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SessionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SessionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SmsMessageLogsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SmsMessageLogsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SmsMessageLogsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessageLogsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SmsMessageLogsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessageLogsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SmsMessagesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SmsMessagesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SmsMessagesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SmsMessagesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SmsMessagesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatusesCodeResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesCodeResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatusesCodeResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesCodeResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatusesCodeResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesCodeResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatusesCodeResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesCodeResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatusesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatusesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatusesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StatusesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StatusesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StorageVolumesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StorageVolumesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StorageVolumesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "StorageVolumesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/StorageVolumesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SupervisorGroupsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SupervisorGroupsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SupervisorGroupsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "SupervisorGroupsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TermUtilityMapsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TermUtilityMapsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TermUtilityMapsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermUtilityMapsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TermUtilityMapsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermUtilityMapsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TermsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TermsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TermsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TermsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TermsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketClosedsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketClosedsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketClosedsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketClosedsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketClosedsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketClosedsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketClosedsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketClosedsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketRequestedServicesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketRequestedServicesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketRequestedServicesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketRequestedServicesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketRequestedServicesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketRequestedServicesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketRequestedServicesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketRequestedServicesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketsInfoResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsInfoResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketsInfoResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsInfoResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketsInfoResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsInfoResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketsInfoResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsInfoResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TicketsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TicketsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpAttachmentResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpAttachmentResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpAttachmentResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpAttachmentResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpAttachmentTagsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpAttachmentTagsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpAttachmentTagsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpAttachmentTagsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpAttachmentTagsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpCustomersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpCustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpCustomersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpCustomersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpCustomersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpCustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpCustomersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpCustomersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpDistrictsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpDistrictsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpDistrictsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpDistrictsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpDistrictsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpDistrictsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpDistrictsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpTicketsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpTicketsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpTicketsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpTicketsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpTicketsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpTicketsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpTicketsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpTicketsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpcustomersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpcustomersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpcustomersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpcustomersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpcustomersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpcustomersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TkpcustomersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TkpcustomersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TokensResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TokensResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TokensResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TokensResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TokensResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionExtrasResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionExtrasResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionExtrasResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionExtrasResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionExtrasResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionExtrasResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsBaseResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsBaseResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsBaseResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsBaseResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsBaseResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsBaseResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsDetailResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsDetailResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsDetailResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsDetailResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsDetailResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsDetailResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsTextResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsTextResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsTextResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsTextResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsTextResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "TransmissionsTextResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/TransmissionsTextResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccessesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccessesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccessesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccessesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccessesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccountAccessViewResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountAccessViewResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccountAccessViewResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountAccessViewResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccountAccessViewResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountAccessViewResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccountAccessViewResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountAccessViewResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccountContractAccessesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccountContractAccessesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccountContractAccessesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserAccountContractAccessesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserAccountContractAccessesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserContactsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserContactsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserContactsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserContactsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserContactsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserContactsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserContactsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserContactsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserDataAccessViewResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessViewResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserDataAccessViewResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessViewResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserDataAccessViewResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessViewResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserDataAccessViewResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessViewResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserDataAccessesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserDataAccessesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserDataAccessesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserDataAccessesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserDataAccessesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserEmployeeAccessesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserEmployeeAccessesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserEmployeeAccessesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserEmployeeAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserEmployeeAccessesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserEmployeeAccessesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserLoginsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserLoginsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserLoginsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserLoginsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserLoginsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserLoginsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserLoginsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserLoginsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserPermissionsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserPermissionsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserPermissionsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserPermissionsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserPermissionsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserPermissionsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserPermissionsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserPermissionsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserProfilesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserProfilesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserProfilesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserProfilesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserProfilesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserProfilesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserProfilesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserProfilesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRequestsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRequestsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRequestsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRequestsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRequestsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRequestsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRequestsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRequestsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRoleAssignmentsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRoleAssignmentsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRoleAssignmentsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRoleAssignmentsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRoleAssignmentsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRoleAssignmentsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRolesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRolesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRolesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserRolesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserRolesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserStatesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserStatesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserStatesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserStatesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserStatesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserStatesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UserStatesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UserStatesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsicContactsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsicContactsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsicContactsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsicContactsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsicContactsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsrRolesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrRolesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsrRolesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrRolesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsrRolesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrRolesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsrRolesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrRolesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsrsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsrsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsrsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UsrsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UsrsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilitiesProfilesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilitiesProfilesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilitiesProfilesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilitiesProfilesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesProfilesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilitiesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilitiesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilitiesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilitiesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilitiesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilityandFacilitiesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilityandFacilitiesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilityandFacilitiesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilityandFacilitiesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "UtilityandFacilitiesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/UtilityandFacilitiesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VehiclesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VehiclesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VehiclesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VehiclesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VehiclesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoriesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoriesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoriesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoriesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventorySfosResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventorySfosResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventorySfosResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventorySfosResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoryUsageSummariesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoryUsageSummariesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoryUsageSummariesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoryUsageSummariesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoryUsagesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoryUsagesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoryUsagesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VerizonWirelessInventoryUsagesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ViolationStatusesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ViolationStatusesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ViolationStatusesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ViolationStatusesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ViolationStatusesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ViolationStatusesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "ViolationStatusesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/ViolationStatusesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VisitLocationsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitLocationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VisitLocationsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitLocationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VisitLocationsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitLocationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VisitLocationsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitLocationsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VisitsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VisitsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VisitsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VisitsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VisitsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VotesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VotesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VotesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VotesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VotesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VotesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "VotesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/VotesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WfNotificationsArchivesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WfNotificationsArchivesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WfNotificationsArchivesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WfNotificationsArchivesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsArchivesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WfNotificationsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WfNotificationsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WfNotificationsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WfNotificationsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WfNotificationsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WirelessInventoriesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WirelessInventoriesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WirelessInventoriesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WirelessInventoriesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WirelessInventoriesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WirelessInventoriesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsUserAccessesResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsUserAccessesResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsUserAccessesResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsUserAccessesResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUserAccessesResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsUsersResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsUsersResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsUsersResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsUsersResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsUsersResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsvLocByContractsResourceReferenceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocByContractsResourceReferenceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsvLocByContractsResourceReferencesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocByContractsResourceReferencesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsvLocByContractsResourceResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocByContractsResourceResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } }, "WsvLocByContractsResourcesResponse" : { "description" : "OK", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/WsvLocByContractsResourcesResponseSchema", "exampleSetFlag" : false }, "exampleSetFlag" : false } } } }, "parameters" : { "PageLimit" : { "name" : "page[limit]", "in" : "query", "description" : "Max number of items", "schema" : { "maximum" : 1000, "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ], "default" : 100 } }, "PageOffset" : { "name" : "page[offset]", "in" : "query", "description" : "Page offset", "schema" : { "type" : "integer", "format" : "int64", "exampleSetFlag" : false, "types" : [ "integer" ], "default" : 0 } }, "NestedFilter" : { "name" : "filter", "in" : "query", "description" : "Customizable query (experimental)", "schema" : { "type" : "object", "properties" : { "AND" : { "type" : "object", "additionalProperties" : true, "nullable" : true, "exampleSetFlag" : false, "types" : [ "object" ] }, "OR" : { "type" : "object", "additionalProperties" : true, "nullable" : true, "exampleSetFlag" : false, "types" : [ "object" ] }, "NOT" : { "type" : "object", "additionalProperties" : true, "nullable" : true, "exampleSetFlag" : false, "types" : [ "object" ] } }, "additionalProperties" : true, "exampleSetFlag" : false, "types" : [ "object" ] } }, "AccrualSummariesSort" : { "name" : "sort", "in" : "query", "description" : "accrualSummaries sort order (csv)", "schema" : { "type" : "string", "example" : "id,period_id,request_id,district_id,accrual_type,beginning_balance,ending_balance,period_amount,attributes1,attributes2,attributes3,current_flag,created_on,created_by,last_updated_on,financialPeriod,cmsRequest,district", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AccrualSummariesFields" : { "name" : "fields", "in" : "query", "description" : "accrualSummaries fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,period_id,request_id,district_id,accrual_type,beginning_balance,ending_balance,period_amount,attributes1,attributes2,attributes3,current_flag,created_on,created_by,last_updated_on,financialPeriod,cmsRequest,district" } }, "AccrualSummariesInclude" : { "name" : "include", "in" : "query", "description" : "accrualSummaries relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "FinancialPeriods,CmsRequests,Districts" } }, "AccrualSummariesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AccrualSummariesIdResourceAttribute", "exampleSetFlag" : false } }, "AccrualsFields" : { "name" : "fields", "in" : "query", "description" : "accruals fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,period_id,amount,accrual_source,accrual_source_id1,accrual_source_id2,accrual_source_id3,district_id,remarks,attributes1,attributes2,attributes3,created_on,created_by,last_updated_on,last_updated_by,request_id,accrual_type,variance_amount,retain_balance,source_accrual_balance,cmsRequest,financialPeriod,district" } }, "AccrualsInclude" : { "name" : "include", "in" : "query", "description" : "accruals relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CmsRequests,FinancialPeriods,Districts" } }, "AccrualsSort" : { "name" : "sort", "in" : "query", "description" : "accruals sort order (csv)", "schema" : { "type" : "string", "example" : "id,period_id,amount,accrual_source,accrual_source_id1,accrual_source_id2,accrual_source_id3,district_id,remarks,attributes1,attributes2,attributes3,created_on,created_by,last_updated_on,last_updated_by,request_id,accrual_type,variance_amount,retain_balance,source_accrual_balance,cmsRequest,financialPeriod,district", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AccrualsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AccrualsIdResourceAttribute", "exampleSetFlag" : false } }, "ActivitiesFields" : { "name" : "fields", "in" : "query", "description" : "activities fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,feet_located,hours_worked,billable_override,billed,closing_override,relevant,locate_id,status_id,high_profile_id,visit_id,addresses_count,wire_center,export_status,locate,locateOpenSnapshot,locateClosedSnapshot,statusCode,visit,firstClosingLocate,responseLogs,activityPathPoints" } }, "ActivitiesInclude" : { "name" : "include", "in" : "query", "description" : "activities relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Locates,LocateOpenSnapshots,LocateClosedSnapshots,StatusesCode,Visits,Locates,ResponseLogs,ActivityPathPoints" } }, "ActivitiesSort" : { "name" : "sort", "in" : "query", "description" : "activities sort order (csv)", "schema" : { "type" : "string", "example" : "id,feet_located,hours_worked,billable_override,billed,closing_override,relevant,locate_id,status_id,high_profile_id,visit_id,addresses_count,wire_center,export_status,locate,locateOpenSnapshot,locateClosedSnapshot,statusCode,visit,firstClosingLocate,responseLogs,activityPathPoints", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ActivitiesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ActivitiesIdResourceAttribute", "exampleSetFlag" : false } }, "ActivityPathPointsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ActivityPathPointsIdResourceAttribute", "exampleSetFlag" : false } }, "ActivityPathPointsSort" : { "name" : "sort", "in" : "query", "description" : "activityPathPoints sort order (csv)", "schema" : { "type" : "string", "example" : "id,activity_id,ticket_id,group_index,order_index,when_captured,lat,lon,source,survey_id,activity,ticket", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ActivityPathPointsInclude" : { "name" : "include", "in" : "query", "description" : "activityPathPoints relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Activities,Tickets" } }, "ActivityPathPointsFields" : { "name" : "fields", "in" : "query", "description" : "activityPathPoints fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,activity_id,ticket_id,group_index,order_index,when_captured,lat,lon,source,survey_id,activity,ticket" } }, "AnnouncementsFields" : { "name" : "fields", "in" : "query", "description" : "announcements fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,announcement_text,effective_start_date,effective_end_date,employee_id,attribute1,attribute2,attribute3,high_priority,employee" } }, "AnnouncementsSort" : { "name" : "sort", "in" : "query", "description" : "announcements sort order (csv)", "schema" : { "type" : "string", "example" : "id,announcement_text,effective_start_date,effective_end_date,employee_id,attribute1,attribute2,attribute3,high_priority,employee", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AnnouncementsInclude" : { "name" : "include", "in" : "query", "description" : "announcements relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees" } }, "AnnouncementsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AnnouncementsIdResourceAttribute", "exampleSetFlag" : false } }, "ApplicationsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ApplicationsIdResourceAttribute", "exampleSetFlag" : false } }, "ApplicationsFields" : { "name" : "fields", "in" : "query", "description" : "applications fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,url,created_on,created_by,last_updated_on,last_updated_by,attachmentEntities,storageVolumes,userDataAccesses" } }, "ApplicationsSort" : { "name" : "sort", "in" : "query", "description" : "applications sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,url,created_on,created_by,last_updated_on,last_updated_by,attachmentEntities,storageVolumes,userDataAccesses", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ApplicationsInclude" : { "name" : "include", "in" : "query", "description" : "applications relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "AttachmentEntities,StorageVolumes,UserDataAccesses" } }, "ApproverListingsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ApproverListingsIdResourceAttribute", "exampleSetFlag" : false } }, "ApproverListingsInclude" : { "name" : "include", "in" : "query", "description" : "approverListings relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,Districts" } }, "ApproverListingsFields" : { "name" : "fields", "in" : "query", "description" : "approverListings fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,activity,district_id,emp_id,start_date,end_date,amount,created_on,created_by,last_updated_on,last_updated_by,job_title,employee,district" } }, "ApproverListingsSort" : { "name" : "sort", "in" : "query", "description" : "approverListings sort order (csv)", "schema" : { "type" : "string", "example" : "id,activity,district_id,emp_id,start_date,end_date,amount,created_on,created_by,last_updated_on,last_updated_by,job_title,employee,district", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetAssignmentsFields" : { "name" : "fields", "in" : "query", "description" : "assetAssignments fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,asset_id,effective_start_date,effective_end_date,active,employee_id,assigned_by,assigned_on,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,primary_flag,employee,employeesActiveNoAsset,employeesActiveMultipleItAssets,assignedByEmployee,employeeOnLoan,asset" } }, "AssetAssignmentsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetAssignmentsIdResourceAttribute", "exampleSetFlag" : false } }, "AssetAssignmentsSort" : { "name" : "sort", "in" : "query", "description" : "assetAssignments sort order (csv)", "schema" : { "type" : "string", "example" : "id,asset_id,effective_start_date,effective_end_date,active,employee_id,assigned_by,assigned_on,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,primary_flag,employee,employeesActiveNoAsset,employeesActiveMultipleItAssets,assignedByEmployee,employeeOnLoan,asset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetAssignmentsInclude" : { "name" : "include", "in" : "query", "description" : "assetAssignments relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,EmployeesActiveNoAssets,EmployeesActiveMultipleItAssets,Employees,EmployeesOnLoan,Assets" } }, "AssetAttributeValuesFields" : { "name" : "fields", "in" : "query", "description" : "assetAttributeValues fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,asset_id,wf_item_id,effective_start_date,effective_end_date,active,record_description,update_process,attribute_id,value,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,assetAttribute" } }, "AssetAttributeValuesInclude" : { "name" : "include", "in" : "query", "description" : "assetAttributeValues relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "AssetAttributes" } }, "AssetAttributeValuesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetAttributeValuesIdResourceAttribute", "exampleSetFlag" : false } }, "AssetAttributeValuesSort" : { "name" : "sort", "in" : "query", "description" : "assetAttributeValues sort order (csv)", "schema" : { "type" : "string", "example" : "id,asset_id,wf_item_id,effective_start_date,effective_end_date,active,record_description,update_process,attribute_id,value,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,assetAttribute", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetAttributesFields" : { "name" : "fields", "in" : "query", "description" : "assetAttributes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,description,label,effective_start_date,effective_end_date,data_type,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,required_field,assetAttributeValues,attributeMappings" } }, "AssetAttributesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetAttributesIdResourceAttribute", "exampleSetFlag" : false } }, "AssetAttributesSort" : { "name" : "sort", "in" : "query", "description" : "assetAttributes sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,description,label,effective_start_date,effective_end_date,data_type,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,required_field,assetAttributeValues,attributeMappings", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetAttributesInclude" : { "name" : "include", "in" : "query", "description" : "assetAttributes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "AssetAttributeValues,AttributeMappings" } }, "AssetCategoriesSort" : { "name" : "sort", "in" : "query", "description" : "assetCategories sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,attribute1,attribute2,attribute3,attribute4,attribute5,categoryTypeMakeMappings", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetCategoriesFields" : { "name" : "fields", "in" : "query", "description" : "assetCategories fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,attribute1,attribute2,attribute3,attribute4,attribute5,categoryTypeMakeMappings" } }, "AssetCategoriesInclude" : { "name" : "include", "in" : "query", "description" : "assetCategories relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CategoryTypeMakeMappings" } }, "AssetCategoriesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetCategoriesIdResourceAttribute", "exampleSetFlag" : false } }, "AssetCategoryTypesFields" : { "name" : "fields", "in" : "query", "description" : "assetCategoryTypes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,attribute1,attribute2,attribute3,attribute4,attribute5,categoryTypeMakeMappings" } }, "AssetCategoryTypesInclude" : { "name" : "include", "in" : "query", "description" : "assetCategoryTypes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CategoryTypeMakeMappings" } }, "AssetCategoryTypesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetCategoryTypesIdResourceAttribute", "exampleSetFlag" : false } }, "AssetCategoryTypesSort" : { "name" : "sort", "in" : "query", "description" : "assetCategoryTypes sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,attribute1,attribute2,attribute3,attribute4,attribute5,categoryTypeMakeMappings", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetMakesSort" : { "name" : "sort", "in" : "query", "description" : "assetMakes sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,attributeMappings,assetModels,categoryTypeMakeMappings", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetMakesInclude" : { "name" : "include", "in" : "query", "description" : "assetMakes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "AttributeMappings,AssetModels,CategoryTypeMakeMappings" } }, "AssetMakesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetMakesIdResourceAttribute", "exampleSetFlag" : false } }, "AssetMakesFields" : { "name" : "fields", "in" : "query", "description" : "assetMakes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,attributeMappings,assetModels,categoryTypeMakeMappings" } }, "AssetModelsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetModelsIdResourceAttribute", "exampleSetFlag" : false } }, "AssetModelsFields" : { "name" : "fields", "in" : "query", "description" : "assetModels fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,make_id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,assets,assetMake" } }, "AssetModelsSort" : { "name" : "sort", "in" : "query", "description" : "assetModels sort order (csv)", "schema" : { "type" : "string", "example" : "id,make_id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,assets,assetMake", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetModelsInclude" : { "name" : "include", "in" : "query", "description" : "assetModels relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Assets,AssetMakes" } }, "AssetStatusesInclude" : { "name" : "include", "in" : "query", "description" : "assetStatuses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Assets" } }, "AssetStatusesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetStatusesIdResourceAttribute", "exampleSetFlag" : false } }, "AssetStatusesSort" : { "name" : "sort", "in" : "query", "description" : "assetStatuses sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,description,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,assets", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetStatusesFields" : { "name" : "fields", "in" : "query", "description" : "assetStatuses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,description,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,assets" } }, "AssetTrackMaintenancesFields" : { "name" : "fields", "in" : "query", "description" : "assetTrackMaintenances fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,asset_id,version_number,asset_type,serial_number,tag_number,contact_name,location_name,organization_name,calibration_due_date,task,asset_status,asset" } }, "AssetTrackMaintenancesInclude" : { "name" : "include", "in" : "query", "description" : "assetTrackMaintenances relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Assets" } }, "AssetTrackMaintenancesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetTrackMaintenancesIdResourceAttribute", "exampleSetFlag" : false } }, "AssetTrackMaintenancesSort" : { "name" : "sort", "in" : "query", "description" : "assetTrackMaintenances sort order (csv)", "schema" : { "type" : "string", "example" : "id,asset_id,version_number,asset_type,serial_number,tag_number,contact_name,location_name,organization_name,calibration_due_date,task,asset_status,asset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetTransferExceptionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetTransferExceptionsIdResourceAttribute", "exampleSetFlag" : false } }, "AssetTransferExceptionsInclude" : { "name" : "include", "in" : "query", "description" : "assetTransferExceptions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Assets" } }, "AssetTransferExceptionsFields" : { "name" : "fields", "in" : "query", "description" : "assetTransferExceptions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,asset_id,version_number,employee_name,job_title,asset_type,serial_number,tag_number,transferring_cost_center,transferring_district_id,receiving_cost_center,receiving_district_id,receiving_supgroup_code,total_days_in_transit,asset_district_id,asset_supgroup_code,employee_id,asset" } }, "AssetTransferExceptionsSort" : { "name" : "sort", "in" : "query", "description" : "assetTransferExceptions sort order (csv)", "schema" : { "type" : "string", "example" : "id,asset_id,version_number,employee_name,job_title,asset_type,serial_number,tag_number,transferring_cost_center,transferring_district_id,receiving_cost_center,receiving_district_id,receiving_supgroup_code,total_days_in_transit,asset_district_id,asset_supgroup_code,employee_id,asset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetTypesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetTypesIdResourceAttribute", "exampleSetFlag" : false } }, "AssetTypesFields" : { "name" : "fields", "in" : "query", "description" : "assetTypes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,attributeMappings,categoryTypeMakeMappings" } }, "AssetTypesInclude" : { "name" : "include", "in" : "query", "description" : "assetTypes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "AttributeMappings,CategoryTypeMakeMappings" } }, "AssetTypesSort" : { "name" : "sort", "in" : "query", "description" : "assetTypes sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,attributeMappings,categoryTypeMakeMappings", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AssetsInclude" : { "name" : "include", "in" : "query", "description" : "assets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Districts,DeletionTypes,RepairReasons,LocatorCheckins,AssetModels,AssetStatuses,CategoryTypeMakeMappings,Employees,AssetAssignments,AssetAssignments,Locations,AssetAttributeValues,NetmotionDevices,SupervisorGroups" } }, "AssetsFields" : { "name" : "fields", "in" : "query", "description" : "assets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,asset_id,version_number,effective_start_date,effective_end_date,description,purchase_date,purchase_price,tax,warranty,warranty_start_date,warranty_end_date,deletion_reason_id,model_id,serial_number,usic_tag,status_id,district_id,active,source_system,search_text,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,mapping_id,location_id,in_transfer,accepted_by_id,supgroup_code,book_value,organization_id,workday_id,tracking_no,police_report_number,repair_reason_id,loss_address,loss_description,loss_date,original_creation_date,reference_id,dist,deletionType,repairReason,locatorCheckins,assetModel,assetStatus,categoryTypeMakeMapping,employeeAcceptedBy,assetAssignment,lastAssignment,location,assetAttributeValues,netmotionDevices,supgroup" } }, "AssetsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AssetsIdResourceAttribute", "exampleSetFlag" : false } }, "AssetsSort" : { "name" : "sort", "in" : "query", "description" : "assets sort order (csv)", "schema" : { "type" : "string", "example" : "id,asset_id,version_number,effective_start_date,effective_end_date,description,purchase_date,purchase_price,tax,warranty,warranty_start_date,warranty_end_date,deletion_reason_id,model_id,serial_number,usic_tag,status_id,district_id,active,source_system,search_text,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,mapping_id,location_id,in_transfer,accepted_by_id,supgroup_code,book_value,organization_id,workday_id,tracking_no,police_report_number,repair_reason_id,loss_address,loss_description,loss_date,original_creation_date,reference_id,dist,deletionType,repairReason,locatorCheckins,assetModel,assetStatus,categoryTypeMakeMapping,employeeAcceptedBy,assetAssignment,lastAssignment,location,assetAttributeValues,netmotionDevices,supgroup", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttAccountsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttAccountsIdResourceAttribute", "exampleSetFlag" : false } }, "AttAccountsFields" : { "name" : "fields", "in" : "query", "description" : "attAccounts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,account_group,account_type,account_group_id,account_level_value" } }, "AttAccountsInclude" : { "name" : "include", "in" : "query", "description" : "attAccounts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "AttAccountsSort" : { "name" : "sort", "in" : "query", "description" : "attAccounts sort order (csv)", "schema" : { "type" : "string", "example" : "id,account_group,account_type,account_group_id,account_level_value", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttProductCatalogItemsFields" : { "name" : "fields", "in" : "query", "description" : "attProductCatalogItems fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,item_type,description,unit_price,unit_measurement,charge_type,soc_code,effective_date,expiration_date,long_description,plan_type,plan_subtype,manufacturer,color,capacity,fn5g_capable,mutually_exclusive_features,incompatible_services,compatible_services,compatible_rateplans,last_updated_on" } }, "AttProductCatalogItemsSort" : { "name" : "sort", "in" : "query", "description" : "attProductCatalogItems sort order (csv)", "schema" : { "type" : "string", "example" : "id,item_type,description,unit_price,unit_measurement,charge_type,soc_code,effective_date,expiration_date,long_description,plan_type,plan_subtype,manufacturer,color,capacity,fn5g_capable,mutually_exclusive_features,incompatible_services,compatible_services,compatible_rateplans,last_updated_on", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttProductCatalogItemsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttProductCatalogItemsIdResourceAttribute", "exampleSetFlag" : false } }, "AttProductCatalogItemsInclude" : { "name" : "include", "in" : "query", "description" : "attProductCatalogItems relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "AttWirelessInventoriesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoriesIdResourceAttribute", "exampleSetFlag" : false } }, "AttWirelessInventoriesFields" : { "name" : "fields", "in" : "query", "description" : "attWirelessInventories fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "imei,fan,ban,billing_account_name,id,wireless_user_status,status_effective_date,wireless_user_full_name,device_make,device_model,wireless_user_activation_date,contract_start_date,contract_end_date,device_effective_date,serivce_type,sim_number,sim_type,rate_plan_name,district_id,employee_id,udl3,udl4,os_version,imeisv,technology_type,last_updated_on" } }, "AttWirelessInventoriesSort" : { "name" : "sort", "in" : "query", "description" : "attWirelessInventories sort order (csv)", "schema" : { "type" : "string", "example" : "imei,fan,ban,billing_account_name,id,wireless_user_status,status_effective_date,wireless_user_full_name,device_make,device_model,wireless_user_activation_date,contract_start_date,contract_end_date,device_effective_date,serivce_type,sim_number,sim_type,rate_plan_name,district_id,employee_id,udl3,udl4,os_version,imeisv,technology_type,last_updated_on", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttWirelessInventoriesInclude" : { "name" : "include", "in" : "query", "description" : "attWirelessInventories relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "AttWirelessInventoryUsagesSort" : { "name" : "sort", "in" : "query", "description" : "attWirelessInventoryUsages sort order (csv)", "schema" : { "type" : "string", "example" : "id,ban,fan,usage_requested_date,billing_cycle_end_date,voice_plan_name,voice_minutes_anytime,data_plan_name_1,data_usage_1,data_plan_name_2,data_usage_2,data_plan_name_3,data_usage_3,data_plan_name_4,data_usage_4,last_updated_on", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttWirelessInventoryUsagesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttWirelessInventoryUsagesIdResourceAttribute", "exampleSetFlag" : false } }, "AttWirelessInventoryUsagesInclude" : { "name" : "include", "in" : "query", "description" : "attWirelessInventoryUsages relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "AttWirelessInventoryUsagesFields" : { "name" : "fields", "in" : "query", "description" : "attWirelessInventoryUsages fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ban,fan,usage_requested_date,billing_cycle_end_date,voice_plan_name,voice_minutes_anytime,data_plan_name_1,data_usage_1,data_plan_name_2,data_usage_2,data_plan_name_3,data_usage_3,data_plan_name_4,data_usage_4,last_updated_on" } }, "AttachEntitiesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttachEntitiesIdResourceAttribute", "exampleSetFlag" : false } }, "AttachEntitiesFields" : { "name" : "fields", "in" : "query", "description" : "attachEntities fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,attachment_entity_name,entity_table,created_on,created_by,last_updated_on,last_updated_by" } }, "AttachEntitiesInclude" : { "name" : "include", "in" : "query", "description" : "attachEntities relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "AttachEntitiesSort" : { "name" : "sort", "in" : "query", "description" : "attachEntities sort order (csv)", "schema" : { "type" : "string", "example" : "id,attachment_entity_name,entity_table,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttachmentInclude" : { "name" : "include", "in" : "query", "description" : "attachment relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "StorageVolumes,AttachmentEntities" } }, "AttachmentFields" : { "name" : "fields", "in" : "query", "description" : "attachment fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,volume_id,priv,path,filename,filetype,filesize,attachment_entity_id,pk1_int,pk2_int,pk3_int,pk1_var,pk2_var,pk3_var,created_on,created_by,last_updated_on,last_updated_by,storageVolume,attachmentEntity" } }, "AttachmentPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttachmentIdResourceAttribute", "exampleSetFlag" : false } }, "AttachmentSort" : { "name" : "sort", "in" : "query", "description" : "attachment sort order (csv)", "schema" : { "type" : "string", "example" : "id,volume_id,priv,path,filename,filetype,filesize,attachment_entity_id,pk1_int,pk2_int,pk3_int,pk1_var,pk2_var,pk3_var,created_on,created_by,last_updated_on,last_updated_by,storageVolume,attachmentEntity", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttachmentEntitiesFields" : { "name" : "fields", "in" : "query", "description" : "attachmentEntities fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,application_id,attachment_entity_name,entity_table,created_on,created_by,last_updated_on,last_updated_by,application,attachments" } }, "AttachmentEntitiesSort" : { "name" : "sort", "in" : "query", "description" : "attachmentEntities sort order (csv)", "schema" : { "type" : "string", "example" : "id,application_id,attachment_entity_name,entity_table,created_on,created_by,last_updated_on,last_updated_by,application,attachments", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttachmentEntitiesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttachmentEntitiesIdResourceAttribute", "exampleSetFlag" : false } }, "AttachmentEntitiesInclude" : { "name" : "include", "in" : "query", "description" : "attachmentEntities relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Applications,Attachment" } }, "AttachmentsCategorizedInclude" : { "name" : "include", "in" : "query", "description" : "attachmentsCategorized relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tickets" } }, "AttachmentsCategorizedSort" : { "name" : "sort", "in" : "query", "description" : "attachmentsCategorized sort order (csv)", "schema" : { "type" : "string", "example" : "id,user_id,ticket_id,attachment_id,file_name,generated_at,received_at,photo_category,lat,lon,passed,account_number,passed_override_by_id,passed_override_at,purpose,probability,manual_category,manual_category_at,manual_category_by_id,customer_facility_type,ticket", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttachmentsCategorizedFields" : { "name" : "fields", "in" : "query", "description" : "attachmentsCategorized fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,user_id,ticket_id,attachment_id,file_name,generated_at,received_at,photo_category,lat,lon,passed,account_number,passed_override_by_id,passed_override_at,purpose,probability,manual_category,manual_category_at,manual_category_by_id,customer_facility_type,ticket" } }, "AttachmentsCategorizedPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttachmentsCategorizedIdResourceAttribute", "exampleSetFlag" : false } }, "AttachmentsWithNotificationsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttachmentsWithNotificationsIdResourceAttribute", "exampleSetFlag" : false } }, "AttachmentsWithNotificationsSort" : { "name" : "sort", "in" : "query", "description" : "attachmentsWithNotifications sort order (csv)", "schema" : { "type" : "string", "example" : "attachment_type,id,attachment_id,entity_kind,entity_id,attached_by,when_attached,when_uploaded,file_name,file_size,hash,status,lat,lon,created_date,created_time,original_ticket_number,attachmentTag,ticket", "exampleSetFlag" : true, "types" : [ "string" ] } }, "AttachmentsWithNotificationsFields" : { "name" : "fields", "in" : "query", "description" : "attachmentsWithNotifications fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "attachment_type,id,attachment_id,entity_kind,entity_id,attached_by,when_attached,when_uploaded,file_name,file_size,hash,status,lat,lon,created_date,created_time,original_ticket_number,attachmentTag,ticket" } }, "AttachmentsWithNotificationsInclude" : { "name" : "include", "in" : "query", "description" : "attachmentsWithNotifications relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "TkpAttachmentTags,Tickets" } }, "AttributeMappingsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/AttributeMappingsIdResourceAttribute", "exampleSetFlag" : false } }, "AttributeMappingsInclude" : { "name" : "include", "in" : "query", "description" : "attributeMappings relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "AssetAttributes,AssetTypes,AssetModels,AssetMakes,QuickCodes" } }, "AttributeMappingsFields" : { "name" : "fields", "in" : "query", "description" : "attributeMappings fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,attribute_id,asset_type_id,model_id,make_id,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,quick_code_id,assetAttribute,assetType,assetModel,assetMake,quickCode" } }, "AttributeMappingsSort" : { "name" : "sort", "in" : "query", "description" : "attributeMappings sort order (csv)", "schema" : { "type" : "string", "example" : "id,attribute_id,asset_type_id,model_id,make_id,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,quick_code_id,assetAttribute,assetType,assetModel,assetMake,quickCode", "exampleSetFlag" : true, "types" : [ "string" ] } }, "BillableCustomersInclude" : { "name" : "include", "in" : "query", "description" : "billableCustomers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CmsCustomers,Facilities,Employees,Employees,States" } }, "BillableCustomersFields" : { "name" : "fields", "in" : "query", "description" : "billableCustomers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,billable_customers_group_id,customer_id,contract_id,state_id,utility_type_id,facility_id,notified_by_category_id,not_billable,inv_photos_required,days_to_send_report,active,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,last_updated_by_id,cmsCustomer,facility,lastUpdatedBy,createdBy,state" } }, "BillableCustomersSort" : { "name" : "sort", "in" : "query", "description" : "billableCustomers sort order (csv)", "schema" : { "type" : "string", "example" : "id,billable_customers_group_id,customer_id,contract_id,state_id,utility_type_id,facility_id,notified_by_category_id,not_billable,inv_photos_required,days_to_send_report,active,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,last_updated_by_id,cmsCustomer,facility,lastUpdatedBy,createdBy,state", "exampleSetFlag" : true, "types" : [ "string" ] } }, "BillableCustomersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/BillableCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "BucketsInclude" : { "name" : "include", "in" : "query", "description" : "buckets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Locates,Usrs" } }, "BucketsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/BucketsIdResourceAttribute", "exampleSetFlag" : false } }, "BucketsFields" : { "name" : "fields", "in" : "query", "description" : "buckets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,user_id,screening,translore,locates,usr" } }, "BucketsSort" : { "name" : "sort", "in" : "query", "description" : "buckets sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,user_id,screening,translore,locates,usr", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CasesSubtypesInclude" : { "name" : "include", "in" : "query", "description" : "casesSubtypes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "LegalCases,CasesTypes" } }, "CasesSubtypesSort" : { "name" : "sort", "in" : "query", "description" : "casesSubtypes sort order (csv)", "schema" : { "type" : "string", "example" : "id,cases_type_id,cases_sub_type_description,created_on,created_by,last_updated_on,last_updated_by,legalCases,casesType", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CasesSubtypesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CasesSubtypesIdResourceAttribute", "exampleSetFlag" : false } }, "CasesSubtypesFields" : { "name" : "fields", "in" : "query", "description" : "casesSubtypes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cases_type_id,cases_sub_type_description,created_on,created_by,last_updated_on,last_updated_by,legalCases,casesType" } }, "CasesTypesInclude" : { "name" : "include", "in" : "query", "description" : "casesTypes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "LegalCases,CasesSubtypes" } }, "CasesTypesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CasesTypesIdResourceAttribute", "exampleSetFlag" : false } }, "CasesTypesSort" : { "name" : "sort", "in" : "query", "description" : "casesTypes sort order (csv)", "schema" : { "type" : "string", "example" : "id,cases_type_description,created_on,created_by,last_updated_on,last_updated_by,legalCases,casesSubtypes", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CasesTypesFields" : { "name" : "fields", "in" : "query", "description" : "casesTypes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cases_type_description,created_on,created_by,last_updated_on,last_updated_by,legalCases,casesSubtypes" } }, "CategoryTypeMakeMappingsFields" : { "name" : "fields", "in" : "query", "description" : "categoryTypeMakeMappings fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,category_id,type_id,make_id,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,attribute1,attribute2,attribute3,attribute4,attribute5,category_type_id,assetCategory,assetType,assetMake,assetCategoryType,assets" } }, "CategoryTypeMakeMappingsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CategoryTypeMakeMappingsIdResourceAttribute", "exampleSetFlag" : false } }, "CategoryTypeMakeMappingsSort" : { "name" : "sort", "in" : "query", "description" : "categoryTypeMakeMappings sort order (csv)", "schema" : { "type" : "string", "example" : "id,category_id,type_id,make_id,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,attribute1,attribute2,attribute3,attribute4,attribute5,category_type_id,assetCategory,assetType,assetMake,assetCategoryType,assets", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CategoryTypeMakeMappingsInclude" : { "name" : "include", "in" : "query", "description" : "categoryTypeMakeMappings relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "AssetCategories,AssetTypes,AssetMakes,AssetCategoryTypes,Assets" } }, "ChangeLogsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ChangeLogsIdResourceAttribute", "exampleSetFlag" : false } }, "ChangeLogsInclude" : { "name" : "include", "in" : "query", "description" : "changeLogs relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Assets" } }, "ChangeLogsFields" : { "name" : "fields", "in" : "query", "description" : "changeLogs fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,asset_id,version_number,active,last_updated_on,last_updated_by,type,fieldname,old_value,new_value,reference_id,asset" } }, "ChangeLogsSort" : { "name" : "sort", "in" : "query", "description" : "changeLogs sort order (csv)", "schema" : { "type" : "string", "example" : "id,asset_id,version_number,active,last_updated_on,last_updated_by,type,fieldname,old_value,new_value,reference_id,asset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ClaimAllocationTypesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ClaimAllocationTypesIdResourceAttribute", "exampleSetFlag" : false } }, "ClaimAllocationTypesInclude" : { "name" : "include", "in" : "query", "description" : "claimAllocationTypes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ClaimCategories" } }, "ClaimAllocationTypesFields" : { "name" : "fields", "in" : "query", "description" : "claimAllocationTypes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,claim_category_id,type_allocation_name,created_on,created_by,last_updated_on,last_updated_by,seq,claimCategory" } }, "ClaimAllocationTypesSort" : { "name" : "sort", "in" : "query", "description" : "claimAllocationTypes sort order (csv)", "schema" : { "type" : "string", "example" : "id,claim_category_id,type_allocation_name,created_on,created_by,last_updated_on,last_updated_by,seq,claimCategory", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ClaimCategoriesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ClaimCategoriesIdResourceAttribute", "exampleSetFlag" : false } }, "ClaimCategoriesSort" : { "name" : "sort", "in" : "query", "description" : "claimCategories sort order (csv)", "schema" : { "type" : "string", "example" : "id,claim_category_name,claim_category_type,created_on,created_by,last_updated_on,last_updated_by,claims,claimAllocationTypes,claimSpendCategories", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ClaimCategoriesInclude" : { "name" : "include", "in" : "query", "description" : "claimCategories relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Claims,ClaimAllocationTypes,ClaimSpendCategories" } }, "ClaimCategoriesFields" : { "name" : "fields", "in" : "query", "description" : "claimCategories fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,claim_category_name,claim_category_type,created_on,created_by,last_updated_on,last_updated_by,claims,claimAllocationTypes,claimSpendCategories" } }, "ClaimDetailsFields" : { "name" : "fields", "in" : "query", "description" : "claimDetails fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,claim_id,damage_id,case_id,payment_amount,created_on,created_by,last_updated_on,last_updated_by,facility_type_id,utility_type_id,facility_id,estimate_variance_reason_id,retain_accrual_balance,investigation_detail_id,estimate_id,accrued,accrued_amount,estimate_version_number,estimate_accrued_balance,estimate_accrued_amount,claim,legalCase,damage,investigationDetail" } }, "ClaimDetailsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ClaimDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "ClaimDetailsInclude" : { "name" : "include", "in" : "query", "description" : "claimDetails relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Claims,LegalCases,Damages,InvestigationDetails" } }, "ClaimDetailsSort" : { "name" : "sort", "in" : "query", "description" : "claimDetails sort order (csv)", "schema" : { "type" : "string", "example" : "id,claim_id,damage_id,case_id,payment_amount,created_on,created_by,last_updated_on,last_updated_by,facility_type_id,utility_type_id,facility_id,estimate_variance_reason_id,retain_accrual_balance,investigation_detail_id,estimate_id,accrued,accrued_amount,estimate_version_number,estimate_accrued_balance,estimate_accrued_amount,claim,legalCase,damage,investigationDetail", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ClaimDiscountsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ClaimDiscountsIdResourceAttribute", "exampleSetFlag" : false } }, "ClaimDiscountsFields" : { "name" : "fields", "in" : "query", "description" : "claimDiscounts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,claim_id,discount_reason,discount_amount,created_on,created_by,last_updated_on,last_updated_by,claim" } }, "ClaimDiscountsInclude" : { "name" : "include", "in" : "query", "description" : "claimDiscounts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Claims" } }, "ClaimDiscountsSort" : { "name" : "sort", "in" : "query", "description" : "claimDiscounts sort order (csv)", "schema" : { "type" : "string", "example" : "id,claim_id,discount_reason,discount_amount,created_on,created_by,last_updated_on,last_updated_by,claim", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ClaimPayeesFields" : { "name" : "fields", "in" : "query", "description" : "claimPayees fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,customer_id,first_name,last_name,created_on,created_by,last_updated_on,last_updated_by,start_date,end_date,cmsCustomer" } }, "ClaimPayeesInclude" : { "name" : "include", "in" : "query", "description" : "claimPayees relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CmsCustomers" } }, "ClaimPayeesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ClaimPayeesIdResourceAttribute", "exampleSetFlag" : false } }, "ClaimPayeesSort" : { "name" : "sort", "in" : "query", "description" : "claimPayees sort order (csv)", "schema" : { "type" : "string", "example" : "id,customer_id,first_name,last_name,created_on,created_by,last_updated_on,last_updated_by,start_date,end_date,cmsCustomer", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ClaimSpendCategoriesSort" : { "name" : "sort", "in" : "query", "description" : "claimSpendCategories sort order (csv)", "schema" : { "type" : "string", "example" : "id,claim_category_id,facility_damage_related,spend_category,wd_acct,created_on,created_by,last_updated_on,last_updated_by,include_pl_rp_paid,claimCategory,claims", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ClaimSpendCategoriesFields" : { "name" : "fields", "in" : "query", "description" : "claimSpendCategories fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,claim_category_id,facility_damage_related,spend_category,wd_acct,created_on,created_by,last_updated_on,last_updated_by,include_pl_rp_paid,claimCategory,claims" } }, "ClaimSpendCategoriesInclude" : { "name" : "include", "in" : "query", "description" : "claimSpendCategories relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ClaimCategories,Claims" } }, "ClaimSpendCategoriesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ClaimSpendCategoriesIdResourceAttribute", "exampleSetFlag" : false } }, "ClaimsFields" : { "name" : "fields", "in" : "query", "description" : "claims fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,customer_id,claim_category_id,invoice_number,invoice_date,invoice_receipt_date,payment_request_date,invoice_amount,payment_amount,cost_center_id,accrued,accrued_amount,accrued_period_id,request_id,payment_mode_id,disputed,dispute_reason_id,period_id,spend_category_id,final_disposition_id,status_id,completed_by,completed_date,approved,approved_by,approved_date,att1_int,att2_int,att3_int,att1_var,att2_var,att3_var,created_on,created_by,last_updated_on,last_updated_by,claim_payee_id,claim_payee_address_id,wf_item_id,search_text,reviewed_by,review_date,notes,paid,damage_id,case_id,docket_number,retain_reserve_balance,settlement_pay_amount,should_cost_estimate,wd_supplier_invoice_reference,should_cost_variance_id,original_claim_id,customer,claimCategory,damage,payeeAddress,claimSpendCategory,financialPeriod,claimDetails,claimDiscounts" } }, "ClaimsSort" : { "name" : "sort", "in" : "query", "description" : "claims sort order (csv)", "schema" : { "type" : "string", "example" : "id,customer_id,claim_category_id,invoice_number,invoice_date,invoice_receipt_date,payment_request_date,invoice_amount,payment_amount,cost_center_id,accrued,accrued_amount,accrued_period_id,request_id,payment_mode_id,disputed,dispute_reason_id,period_id,spend_category_id,final_disposition_id,status_id,completed_by,completed_date,approved,approved_by,approved_date,att1_int,att2_int,att3_int,att1_var,att2_var,att3_var,created_on,created_by,last_updated_on,last_updated_by,claim_payee_id,claim_payee_address_id,wf_item_id,search_text,reviewed_by,review_date,notes,paid,damage_id,case_id,docket_number,retain_reserve_balance,settlement_pay_amount,should_cost_estimate,wd_supplier_invoice_reference,should_cost_variance_id,original_claim_id,customer,claimCategory,damage,payeeAddress,claimSpendCategory,financialPeriod,claimDetails,claimDiscounts", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ClaimsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ClaimsIdResourceAttribute", "exampleSetFlag" : false } }, "ClaimsInclude" : { "name" : "include", "in" : "query", "description" : "claims relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Customers,ClaimCategories,Damages,PayeeAddresses,ClaimSpendCategories,FinancialPeriods,ClaimDetails,ClaimDiscounts" } }, "ClosedTicketsSort" : { "name" : "sort", "in" : "query", "description" : "closedTickets sort order (csv)", "schema" : { "type" : "string", "example" : "id,count,account_number,contract_number", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ClosedTicketsFields" : { "name" : "fields", "in" : "query", "description" : "closedTickets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,count,account_number,contract_number" } }, "ClosedTicketsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ClosedTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "ClosedTicketsInclude" : { "name" : "include", "in" : "query", "description" : "closedTickets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "CmsCustomersSort" : { "name" : "sort", "in" : "query", "description" : "cmsCustomers sort order (csv)", "schema" : { "type" : "string", "example" : "id,account_level_customer_id,account_level_customer,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,active,damageCustomers,claimPayees,flatRateCustomers,billableCustomers,investigationDetailsVersions", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CmsCustomersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CmsCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "CmsCustomersInclude" : { "name" : "include", "in" : "query", "description" : "cmsCustomers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "DamageCustomers,ClaimPayees,FlatRateCustomers,BillableCustomers,InvestigationDetailsVersions" } }, "CmsCustomersFields" : { "name" : "fields", "in" : "query", "description" : "cmsCustomers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,account_level_customer_id,account_level_customer,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,active,damageCustomers,claimPayees,flatRateCustomers,billableCustomers,investigationDetailsVersions" } }, "CmsDistrictsInclude" : { "name" : "include", "in" : "query", "description" : "cmsDistricts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "CmsDistrictsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CmsDistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "CmsDistrictsFields" : { "name" : "fields", "in" : "query", "description" : "cmsDistricts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,workday_id,district_code,district_abbr,district_name,state,region,created_on,created_by,last_updated_on,last_updated_by" } }, "CmsDistrictsSort" : { "name" : "sort", "in" : "query", "description" : "cmsDistricts sort order (csv)", "schema" : { "type" : "string", "example" : "id,workday_id,district_code,district_abbr,district_name,state,region,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CmsErrorLogsSort" : { "name" : "sort", "in" : "query", "description" : "cmsErrorLogs sort order (csv)", "schema" : { "type" : "string", "example" : "id,severity,error_state,module,line_no,message,creation_date", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CmsErrorLogsFields" : { "name" : "fields", "in" : "query", "description" : "cmsErrorLogs fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,severity,error_state,module,line_no,message,creation_date" } }, "CmsErrorLogsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CmsErrorLogsIdResourceAttribute", "exampleSetFlag" : false } }, "CmsErrorLogsInclude" : { "name" : "include", "in" : "query", "description" : "cmsErrorLogs relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "CmsInvestigationDetailsSort" : { "name" : "sort", "in" : "query", "description" : "cmsInvestigationDetails sort order (csv)", "schema" : { "type" : "string", "example" : "id,investigation_id,customer_id,utility_type_id,facility_type_id,facility_id,locator_id,created_on,created_by,last_updated_on,last_updated_by,wf_item_id,active,investigation_root_cause_id,completed,completed_by,completed_date,search_text,att1,att2,att3,att4,att5,supgroup,supervisor_id,event_summary,video_url,inv_report_attachment_id,customer,investigation,employee,estimates,investigationDetailLines,investigationReport,utilitiesProfilesView", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CmsInvestigationDetailsInclude" : { "name" : "include", "in" : "query", "description" : "cmsInvestigationDetails relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Customers,Investigations,Employees,Estimates,InvestigationDetailLines,DamagePhotos,UtilitiesProfiles" } }, "CmsInvestigationDetailsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CmsInvestigationDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "CmsInvestigationDetailsFields" : { "name" : "fields", "in" : "query", "description" : "cmsInvestigationDetails fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,investigation_id,customer_id,utility_type_id,facility_type_id,facility_id,locator_id,created_on,created_by,last_updated_on,last_updated_by,wf_item_id,active,investigation_root_cause_id,completed,completed_by,completed_date,search_text,att1,att2,att3,att4,att5,supgroup,supervisor_id,event_summary,video_url,inv_report_attachment_id,customer,investigation,employee,estimates,investigationDetailLines,investigationReport,utilitiesProfilesView" } }, "CmsRequestsInclude" : { "name" : "include", "in" : "query", "description" : "cmsRequests relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "AccrualSummaries,Accruals,LegalRisks,PolicyDropOffEstimates" } }, "CmsRequestsFields" : { "name" : "fields", "in" : "query", "description" : "cmsRequests fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,userid,username,session_id,start_time,end_time,request_name,request_type,completed_status,param1,param2,param3,param4,param5,param6,param7,param8,param9,param10,created_on,created_by,last_updated_on,last_updated_by,accrualSummaries,accruals,legalRisks,policyDropOffEstimates" } }, "CmsRequestsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CmsRequestsIdResourceAttribute", "exampleSetFlag" : false } }, "CmsRequestsSort" : { "name" : "sort", "in" : "query", "description" : "cmsRequests sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,userid,username,session_id,start_time,end_time,request_name,request_type,completed_status,param1,param2,param3,param4,param5,param6,param7,param8,param9,param10,created_on,created_by,last_updated_on,last_updated_by,accrualSummaries,accruals,legalRisks,policyDropOffEstimates", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CmsUserDataAccessesSort" : { "name" : "sort", "in" : "query", "description" : "cmsUserDataAccesses sort order (csv)", "schema" : { "type" : "string", "example" : "id,peoplesoft_id,district_id,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,all_districts,district", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CmsUserDataAccessesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CmsUserDataAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "CmsUserDataAccessesInclude" : { "name" : "include", "in" : "query", "description" : "cmsUserDataAccesses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Districts" } }, "CmsUserDataAccessesFields" : { "name" : "fields", "in" : "query", "description" : "cmsUserDataAccesses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,peoplesoft_id,district_id,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,all_districts,district" } }, "CommentsSort" : { "name" : "sort", "in" : "query", "description" : "comments sort order (csv)", "schema" : { "type" : "string", "example" : "id,content,idea_id,author_id,created_on,created_by,last_updated_on,last_updated_by,employee,idea", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CommentsFields" : { "name" : "fields", "in" : "query", "description" : "comments fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,content,idea_id,author_id,created_on,created_by,last_updated_on,last_updated_by,employee,idea" } }, "CommentsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CommentsIdResourceAttribute", "exampleSetFlag" : false } }, "CommentsInclude" : { "name" : "include", "in" : "query", "description" : "comments relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,Ideas" } }, "ContractsSort" : { "name" : "sort", "in" : "query", "description" : "contracts sort order (csv)", "schema" : { "type" : "string", "example" : "id,contract_name,status,customer_contract_number,usic_contract_number,account_name,account_number,contract_effective_date,contract_expiration_date,contract_stage,contract_type,primary_utility_type,utility_type,quote,usic_contract_type,damage_liability,master_contract_number,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,customer", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ContractsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ContractsIdResourceAttribute", "exampleSetFlag" : false } }, "ContractsInclude" : { "name" : "include", "in" : "query", "description" : "contracts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Customers" } }, "ContractsFields" : { "name" : "fields", "in" : "query", "description" : "contracts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,contract_name,status,customer_contract_number,usic_contract_number,account_name,account_number,contract_effective_date,contract_expiration_date,contract_stage,contract_type,primary_utility_type,utility_type,quote,usic_contract_type,damage_liability,master_contract_number,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,customer" } }, "CountriesSort" : { "name" : "sort", "in" : "query", "description" : "countries sort order (csv)", "schema" : { "type" : "string", "example" : "id,country_code,country_name,created_on,created_by,last_updated_on,last_updated_by,locations,states", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CountriesInclude" : { "name" : "include", "in" : "query", "description" : "countries relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Locations,States" } }, "CountriesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CountriesIdResourceAttribute", "exampleSetFlag" : false } }, "CountriesFields" : { "name" : "fields", "in" : "query", "description" : "countries fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,country_code,country_name,created_on,created_by,last_updated_on,last_updated_by,locations,states" } }, "CpDistrictsInclude" : { "name" : "include", "in" : "query", "description" : "cpDistricts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "UsicContacts" } }, "CpDistrictsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CpDistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "CpDistrictsSort" : { "name" : "sort", "in" : "query", "description" : "cpDistricts sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_workday_id,cp_district_code,cp_district_abbr,cp_district_name,cp_state,cp_region,cp_created_on,cp_created_by,cp_last_updated_on,cp_last_updated_by,usicContacts", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CpDistrictsFields" : { "name" : "fields", "in" : "query", "description" : "cpDistricts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_workday_id,cp_district_code,cp_district_abbr,cp_district_name,cp_state,cp_region,cp_created_on,cp_created_by,cp_last_updated_on,cp_last_updated_by,usicContacts" } }, "CpstorageVolumesInclude" : { "name" : "include", "in" : "query", "description" : "cpstorageVolumes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "CpstorageVolumesFields" : { "name" : "fields", "in" : "query", "description" : "cpstorageVolumes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,path,protocol,active,attribute1,attribute2,attribute3,created_on,created_by,last_updated_on,last_updated_by" } }, "CpstorageVolumesSort" : { "name" : "sort", "in" : "query", "description" : "cpstorageVolumes sort order (csv)", "schema" : { "type" : "string", "example" : "id,path,protocol,active,attribute1,attribute2,attribute3,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CpstorageVolumesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CpstorageVolumesIdResourceAttribute", "exampleSetFlag" : false } }, "CustomerAccountActivitiesInclude" : { "name" : "include", "in" : "query", "description" : "customerAccountActivities relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CustomerAccounts" } }, "CustomerAccountActivitiesSort" : { "name" : "sort", "in" : "query", "description" : "customerAccountActivities sort order (csv)", "schema" : { "type" : "string", "example" : "id,account_number,account_name,num_users,show_tickets,show_damages,show_managed_services,last_logged_on,days,customerAccount", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CustomerAccountActivitiesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CustomerAccountActivitiesIdResourceAttribute", "exampleSetFlag" : false } }, "CustomerAccountActivitiesFields" : { "name" : "fields", "in" : "query", "description" : "customerAccountActivities fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,account_number,account_name,num_users,show_tickets,show_damages,show_managed_services,last_logged_on,days,customerAccount" } }, "CustomerAccountNotesFields" : { "name" : "fields", "in" : "query", "description" : "customerAccountNotes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,account_number,note,active,created_on,created_by,last_updated_on,last_updated_by,customerAccount" } }, "CustomerAccountNotesSort" : { "name" : "sort", "in" : "query", "description" : "customerAccountNotes sort order (csv)", "schema" : { "type" : "string", "example" : "id,account_number,note,active,created_on,created_by,last_updated_on,last_updated_by,customerAccount", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CustomerAccountNotesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CustomerAccountNotesIdResourceAttribute", "exampleSetFlag" : false } }, "CustomerAccountNotesInclude" : { "name" : "include", "in" : "query", "description" : "customerAccountNotes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CustomerAccounts" } }, "CustomerAccountsSort" : { "name" : "sort", "in" : "query", "description" : "customerAccounts sort order (csv)", "schema" : { "type" : "string", "example" : "id,account_number,parent_account_number,account_name,alt_name,item_status,created_on,created_by,last_updated_on,last_updated_by,customerContracts,customerAccountNotes,userAccesses,customerContractSettings,userAccountContractAccess", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CustomerAccountsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CustomerAccountsIdResourceAttribute", "exampleSetFlag" : false } }, "CustomerAccountsFields" : { "name" : "fields", "in" : "query", "description" : "customerAccounts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,account_number,parent_account_number,account_name,alt_name,item_status,created_on,created_by,last_updated_on,last_updated_by,customerContracts,customerAccountNotes,userAccesses,customerContractSettings,userAccountContractAccess" } }, "CustomerAccountsInclude" : { "name" : "include", "in" : "query", "description" : "customerAccounts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CustomerContracts,CustomerAccountNotes,UserAccesses,CustomerContractSettings" } }, "CustomerContractSettingsInclude" : { "name" : "include", "in" : "query", "description" : "customerContractSettings relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CustomerContracts,CustomerAccounts" } }, "CustomerContractSettingsSort" : { "name" : "sort", "in" : "query", "description" : "customerContractSettings sort order (csv)", "schema" : { "type" : "string", "example" : "id,account_number,contract_number,theme,filter_attachments,created_on,created_by,last_updated_on,last_updated_by,customerContract,customerAccount", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CustomerContractSettingsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CustomerContractSettingsIdResourceAttribute", "exampleSetFlag" : false } }, "CustomerContractSettingsFields" : { "name" : "fields", "in" : "query", "description" : "customerContractSettings fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,account_number,contract_number,theme,filter_attachments,created_on,created_by,last_updated_on,last_updated_by,customerContract,customerAccount" } }, "CustomerContractStatesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CustomerContractStatesIdResourceAttribute", "exampleSetFlag" : false } }, "CustomerContractStatesFields" : { "name" : "fields", "in" : "query", "description" : "customerContractStates fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,account_number,contract_number,state,created_on,created_by,last_updated_on,last_updated_by,customer" } }, "CustomerContractStatesSort" : { "name" : "sort", "in" : "query", "description" : "customerContractStates sort order (csv)", "schema" : { "type" : "string", "example" : "id,account_number,contract_number,state,created_on,created_by,last_updated_on,last_updated_by,customer", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CustomerContractStatesInclude" : { "name" : "include", "in" : "query", "description" : "customerContractStates relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Customers" } }, "CustomerContractsInclude" : { "name" : "include", "in" : "query", "description" : "customerContracts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "UserAccountContractAccesses,UserAccesses,CustomerContractSettings" } }, "CustomerContractsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CustomerContractsIdResourceAttribute", "exampleSetFlag" : false } }, "CustomerContractsSort" : { "name" : "sort", "in" : "query", "description" : "customerContracts sort order (csv)", "schema" : { "type" : "string", "example" : "id,contract_number,account_number,contract_name,status,item_status,created_on,created_by,last_updated_on,last_updated_by,state,userAccountContractAccesses,userAccesses,customerContractSetting", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CustomerContractsFields" : { "name" : "fields", "in" : "query", "description" : "customerContracts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,contract_number,account_number,contract_name,status,item_status,created_on,created_by,last_updated_on,last_updated_by,state,userAccountContractAccesses,userAccesses,customerContractSetting" } }, "CustomersSort" : { "name" : "sort", "in" : "query", "description" : "customers sort order (csv)", "schema" : { "type" : "string", "example" : "id,account_level_customer_id,account_level_customer,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,contracts", "exampleSetFlag" : true, "types" : [ "string" ] } }, "CustomersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/CustomersIdResourceAttribute", "exampleSetFlag" : false } }, "CustomersInclude" : { "name" : "include", "in" : "query", "description" : "customers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Contracts" } }, "CustomersFields" : { "name" : "fields", "in" : "query", "description" : "customers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,account_level_customer_id,account_level_customer,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,contracts" } }, "DamageCustomersInclude" : { "name" : "include", "in" : "query", "description" : "damageCustomers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CmsCustomers,Damages" } }, "DamageCustomersFields" : { "name" : "fields", "in" : "query", "description" : "damageCustomers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,customer_id,damage_id,created_on,created_by,last_updated_on,last_updated_by,cmsCustomer,damage" } }, "DamageCustomersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DamageCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "DamageCustomersSort" : { "name" : "sort", "in" : "query", "description" : "damageCustomers sort order (csv)", "schema" : { "type" : "string", "example" : "id,customer_id,damage_id,created_on,created_by,last_updated_on,last_updated_by,cmsCustomer,damage", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DamageDetailsFields" : { "name" : "fields", "in" : "query", "description" : "damageDetails fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "dd_investigation_id,id,dd_notification_id,dd_district,dd_address_1,dd_address_2,dd_city,dd_state,dd_zip_code,dd_orig_request_id,dd_damage_date,dd_date_reported,dd_notified_by,dd_caller_company,dd_damaging_excavator,dd_cdi_emp_id,dd_cdi_confirmation,dd_notes,dd_investigation_date_from,dd_investigation_date_to,dd_type_of_excavation,dd_orig_locate_request,dd_start_date,dd_type_of_ticket,dd_damage_request,dd_further_investigation_needed,dd_contact_info,dd_call_date,dd_damaged_customer,dd_pictures_taken_by" } }, "DamageDetailsInclude" : { "name" : "include", "in" : "query", "description" : "damageDetails relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "DamageDetailsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DamageDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "DamageDetailsSort" : { "name" : "sort", "in" : "query", "description" : "damageDetails sort order (csv)", "schema" : { "type" : "string", "example" : "dd_investigation_id,id,dd_notification_id,dd_district,dd_address_1,dd_address_2,dd_city,dd_state,dd_zip_code,dd_orig_request_id,dd_damage_date,dd_date_reported,dd_notified_by,dd_caller_company,dd_damaging_excavator,dd_cdi_emp_id,dd_cdi_confirmation,dd_notes,dd_investigation_date_from,dd_investigation_date_to,dd_type_of_excavation,dd_orig_locate_request,dd_start_date,dd_type_of_ticket,dd_damage_request,dd_further_investigation_needed,dd_contact_info,dd_call_date,dd_damaged_customer,dd_pictures_taken_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DamageListingsSort" : { "name" : "sort", "in" : "query", "description" : "damageListings sort order (csv)", "schema" : { "type" : "string", "example" : "id,dl_notification_id,dl_damage_id,dl_add1,dl_city,dl_abbrev,dl_damage_date_time,dl_excavator,dl_customer_id,dl_account_number,dl_customer_claim_number,dl_duplicate_damage_id,damage,duplicateDamage", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DamageListingsInclude" : { "name" : "include", "in" : "query", "description" : "damageListings relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Damages,Damages" } }, "DamageListingsFields" : { "name" : "fields", "in" : "query", "description" : "damageListings fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,dl_notification_id,dl_damage_id,dl_add1,dl_city,dl_abbrev,dl_damage_date_time,dl_excavator,dl_customer_id,dl_account_number,dl_customer_claim_number,dl_duplicate_damage_id,damage,duplicateDamage" } }, "DamageListingsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DamageListingsIdResourceAttribute", "exampleSetFlag" : false } }, "DamagePhotosFields" : { "name" : "fields", "in" : "query", "description" : "damagePhotos fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,volume_id,priv,path,filetype,filename,filesize,attachment_entity_id,pk1_int,attachment_entity_name,entity_table,protocol,fullUrl,fulltnUrl,number,damage,attachmentEntities,cmsInvestigationDetail,investigationDetail,host,entityID,vol" } }, "DamagePhotosInclude" : { "name" : "include", "in" : "query", "description" : "damagePhotos relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Damages,AttachEntities,CmsInvestigationDetails,InvestigationDetails" } }, "DamagePhotosSort" : { "name" : "sort", "in" : "query", "description" : "damagePhotos sort order (csv)", "schema" : { "type" : "string", "example" : "id,volume_id,priv,path,filetype,filename,filesize,attachment_entity_id,pk1_int,attachment_entity_name,entity_table,protocol,fullUrl,fulltnUrl,number,damage,attachmentEntities,cmsInvestigationDetail,investigationDetail,host,entityID,vol", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DamagePhotosPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DamagePhotosIdResourceAttribute", "exampleSetFlag" : false } }, "DamagesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DamagesIdResourceAttribute", "exampleSetFlag" : false } }, "DamagesFields" : { "name" : "fields", "in" : "query", "description" : "damages fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,damage_reported_date,damage_create_date,damage_date_time,dispatcher_id,district_id,excavator_id,facility_type_id,notified_category_id,cdi_id,one_call_request_num,notified_by_name,add_1,add_2,city,zip,cross_str1,ticket_id,ticket_number,caller_stmt_call_notes,created_on,created_by,last_updated_on,last_updated_by,damage_number,stateid,countryid,ticket_start_date,ticket_closed_date,notified_by_phone,notified_by_email,active,excavator,locator_id,locator_first_nm,locator_last_nm,cross_str2,county,ticket_type,type_of_work,boring,wf_item_id,source,notified_by_extension,search_text,caller_company,paged_date_time,confirmaton_date_time,customer_rep,cdi_confirmation,latitude,longitude,geo_location,utility_type_id,facility_id,dots_number,customer_claim_number,customer_claim_number_2,supgroup,one_call_request_ticket_id,claims,legalDamages,claimDetails,investigation,policyDropOffEstimates,district,employee,state,damageListings,investigationVersions,damagePhotos" } }, "DamagesInclude" : { "name" : "include", "in" : "query", "description" : "damages relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Claims,LegalDamages,ClaimDetails,Investigations,PolicyDropOffEstimates,Districts,Employees,States,DamageListings,InvestigationVersions,DamagePhotos" } }, "DamagesSort" : { "name" : "sort", "in" : "query", "description" : "damages sort order (csv)", "schema" : { "type" : "string", "example" : "id,damage_reported_date,damage_create_date,damage_date_time,dispatcher_id,district_id,excavator_id,facility_type_id,notified_category_id,cdi_id,one_call_request_num,notified_by_name,add_1,add_2,city,zip,cross_str1,ticket_id,ticket_number,caller_stmt_call_notes,created_on,created_by,last_updated_on,last_updated_by,damage_number,stateid,countryid,ticket_start_date,ticket_closed_date,notified_by_phone,notified_by_email,active,excavator,locator_id,locator_first_nm,locator_last_nm,cross_str2,county,ticket_type,type_of_work,boring,wf_item_id,source,notified_by_extension,search_text,caller_company,paged_date_time,confirmaton_date_time,customer_rep,cdi_confirmation,latitude,longitude,geo_location,utility_type_id,facility_id,dots_number,customer_claim_number,customer_claim_number_2,supgroup,one_call_request_ticket_id,claims,legalDamages,claimDetails,investigation,policyDropOffEstimates,district,employee,state,damageListings,investigationVersions,damagePhotos", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DeletionTypesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DeletionTypesIdResourceAttribute", "exampleSetFlag" : false } }, "DeletionTypesFields" : { "name" : "fields", "in" : "query", "description" : "deletionTypes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,assets" } }, "DeletionTypesSort" : { "name" : "sort", "in" : "query", "description" : "deletionTypes sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,assets", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DeletionTypesInclude" : { "name" : "include", "in" : "query", "description" : "deletionTypes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Assets" } }, "DeviceTokensSort" : { "name" : "sort", "in" : "query", "description" : "deviceTokens sort order (csv)", "schema" : { "type" : "string", "example" : "id,employee_id,device_token,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,last_updated_on,employee", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DeviceTokensInclude" : { "name" : "include", "in" : "query", "description" : "deviceTokens relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees" } }, "DeviceTokensFields" : { "name" : "fields", "in" : "query", "description" : "deviceTokens fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,employee_id,device_token,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,last_updated_on,employee" } }, "DeviceTokensPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DeviceTokensIdResourceAttribute", "exampleSetFlag" : false } }, "DigAreasFields" : { "name" : "fields", "in" : "query", "description" : "digAreas fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,transmission_id,lat,lon,order_number,group_index,transmissionDetail" } }, "DigAreasSort" : { "name" : "sort", "in" : "query", "description" : "digAreas sort order (csv)", "schema" : { "type" : "string", "example" : "id,transmission_id,lat,lon,order_number,group_index,transmissionDetail", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DigAreasPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DigAreasIdResourceAttribute", "exampleSetFlag" : false } }, "DigAreasInclude" : { "name" : "include", "in" : "query", "description" : "digAreas relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "TransmissionsDetail" } }, "DistrictBoundariesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DistrictBoundariesIdResourceAttribute", "exampleSetFlag" : false } }, "DistrictBoundariesInclude" : { "name" : "include", "in" : "query", "description" : "districtBoundaries relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "DistrictBoundariesSort" : { "name" : "sort", "in" : "query", "description" : "districtBoundaries sort order (csv)", "schema" : { "type" : "string", "example" : "id,color,contact_info,distric_name,boundaries", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DistrictBoundariesFields" : { "name" : "fields", "in" : "query", "description" : "districtBoundaries fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,color,contact_info,distric_name,boundaries" } }, "DistrictLocationsInclude" : { "name" : "include", "in" : "query", "description" : "districtLocations relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Districts,Locations" } }, "DistrictLocationsSort" : { "name" : "sort", "in" : "query", "description" : "districtLocations sort order (csv)", "schema" : { "type" : "string", "example" : "id,district_id,location_id,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,dist,location", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DistrictLocationsFields" : { "name" : "fields", "in" : "query", "description" : "districtLocations fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,district_id,location_id,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,dist,location" } }, "DistrictLocationsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DistrictLocationsIdResourceAttribute", "exampleSetFlag" : false } }, "DistrictsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "DistrictsFields" : { "name" : "fields", "in" : "query", "description" : "districts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,workday_id,district_code,district_abbr,district_name,state,region,district_manager_employee_id,created_on,created_by,last_updated_on,last_updated_by,employees,employeesOnLoans,employeesActiveNoAssets,supervisorGroups,assets,districtLocations,userDataAccesses,locations" } }, "DistrictsInclude" : { "name" : "include", "in" : "query", "description" : "districts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,EmployeesOnLoan,EmployeesActiveNoAssets,SupervisorGroups,Assets,DistrictLocations,UserDataAccesses,Locations" } }, "DistrictsSort" : { "name" : "sort", "in" : "query", "description" : "districts sort order (csv)", "schema" : { "type" : "string", "example" : "id,workday_id,district_code,district_abbr,district_name,state,region,district_manager_employee_id,created_on,created_by,last_updated_on,last_updated_by,employees,employeesOnLoans,employeesActiveNoAssets,supervisorGroups,assets,districtLocations,userDataAccesses,locations", "exampleSetFlag" : true, "types" : [ "string" ] } }, "DueDateExtensionsFields" : { "name" : "fields", "in" : "query", "description" : "dueDateExtensions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_id,usr_id,when_extended,due_date,approved_by,approver_phone,notes,reason,old_due_date,when_entered,visit_id,ticket,usr,visit" } }, "DueDateExtensionsInclude" : { "name" : "include", "in" : "query", "description" : "dueDateExtensions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tickets,Usrs,Visits" } }, "DueDateExtensionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/DueDateExtensionsIdResourceAttribute", "exampleSetFlag" : false } }, "DueDateExtensionsSort" : { "name" : "sort", "in" : "query", "description" : "dueDateExtensions sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_id,usr_id,when_extended,due_date,approved_by,approver_phone,notes,reason,old_due_date,when_entered,visit_id,ticket,usr,visit", "exampleSetFlag" : true, "types" : [ "string" ] } }, "EmployeeMessagesSort" : { "name" : "sort", "in" : "query", "description" : "employeeMessages sort order (csv)", "schema" : { "type" : "string", "example" : "id,employee_id,message_id,status_id,sent_at,first_read_at,last_read_at,cleared_at,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,reference_id,acknowledged_at,channel,recipient_email,delivery_detail,delivery_attempts,claimed_at,schedulerInfo,employee,message,messageWithCount,status", "exampleSetFlag" : true, "types" : [ "string" ] } }, "EmployeeMessagesInclude" : { "name" : "include", "in" : "query", "description" : "employeeMessages relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,Messages,MessagesWithCounts,Statuses" } }, "EmployeeMessagesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/EmployeeMessagesIdResourceAttribute", "exampleSetFlag" : false } }, "EmployeeMessagesFields" : { "name" : "fields", "in" : "query", "description" : "employeeMessages fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,employee_id,message_id,status_id,sent_at,first_read_at,last_read_at,cleared_at,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,reference_id,acknowledged_at,channel,recipient_email,delivery_detail,delivery_attempts,claimed_at,schedulerInfo,employee,message,messageWithCount,status" } }, "EmployeesSort" : { "name" : "sort", "in" : "query", "description" : "employees sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,action,reason,estimated_return_date,dist,supgroup,announcements,assetAssignments,assignments,requests,acceptedAssets,wirelessInventories,vehicles,userDataAccesses,locatorCheckins,deviceTokens,employeeMessages,messages,schedulerJobsInfo,investigations,comments,ideas,display_name", "exampleSetFlag" : true, "types" : [ "string" ] } }, "EmployeesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/EmployeesIdResourceAttribute", "exampleSetFlag" : false } }, "EmployeesFields" : { "name" : "fields", "in" : "query", "description" : "employees fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,action,reason,estimated_return_date,dist,supgroup,announcements,assetAssignments,assignments,requests,acceptedAssets,wirelessInventories,vehicles,userDataAccesses,locatorCheckins,deviceTokens,employeeMessages,messages,schedulerJobsInfo,investigations,comments,ideas,display_name" } }, "EmployeesInclude" : { "name" : "include", "in" : "query", "description" : "employees relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Districts,SupervisorGroups,Announcements,AssetAssignments,AssetAssignments,Requests,Assets,WirelessInventories,Vehicles,UserDataAccesses,LocatorCheckins,DeviceTokens,EmployeeMessages,Messages,SchedulerJobs,Investigations,Comments,Ideas" } }, "EmployeesActiveMultipleItAssetsFields" : { "name" : "fields", "in" : "query", "description" : "employeesActiveMultipleItAssets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,action,reason,estimated_return_date,dist,supgroup,vehicles,assetAssignments" } }, "EmployeesActiveMultipleItAssetsSort" : { "name" : "sort", "in" : "query", "description" : "employeesActiveMultipleItAssets sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,action,reason,estimated_return_date,dist,supgroup,vehicles,assetAssignments", "exampleSetFlag" : true, "types" : [ "string" ] } }, "EmployeesActiveMultipleItAssetsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/EmployeesActiveMultipleItAssetsIdResourceAttribute", "exampleSetFlag" : false } }, "EmployeesActiveMultipleItAssetsInclude" : { "name" : "include", "in" : "query", "description" : "employeesActiveMultipleItAssets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Districts,SupervisorGroups,Vehicles,AssetAssignments" } }, "EmployeesActiveNoAssetsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/EmployeesActiveNoAssetsIdResourceAttribute", "exampleSetFlag" : false } }, "EmployeesActiveNoAssetsInclude" : { "name" : "include", "in" : "query", "description" : "employeesActiveNoAssets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Districts,SupervisorGroups,Vehicles,AssetAssignments" } }, "EmployeesActiveNoAssetsFields" : { "name" : "fields", "in" : "query", "description" : "employeesActiveNoAssets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,dist,supgroup,vehicles,assetAssignments" } }, "EmployeesActiveNoAssetsSort" : { "name" : "sort", "in" : "query", "description" : "employeesActiveNoAssets sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,dist,supgroup,vehicles,assetAssignments", "exampleSetFlag" : true, "types" : [ "string" ] } }, "EmployeesOnLoanInclude" : { "name" : "include", "in" : "query", "description" : "employeesOnLoan relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Districts,SupervisorGroups,AssetAssignments,Vehicles,WirelessInventories" } }, "EmployeesOnLoanFields" : { "name" : "fields", "in" : "query", "description" : "employeesOnLoan fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,dist,supgroup,assetAssignments,vehicles,wirelessInventories" } }, "EmployeesOnLoanSort" : { "name" : "sort", "in" : "query", "description" : "employeesOnLoan sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,dist,supgroup,assetAssignments,vehicles,wirelessInventories", "exampleSetFlag" : true, "types" : [ "string" ] } }, "EmployeesOnLoanPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/EmployeesOnLoanIdResourceAttribute", "exampleSetFlag" : false } }, "ErrorLogsSort" : { "name" : "sort", "in" : "query", "description" : "errorLogs sort order (csv)", "schema" : { "type" : "string", "example" : "id,severity,error_state,module,line_no,message,creation_date", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ErrorLogsInclude" : { "name" : "include", "in" : "query", "description" : "errorLogs relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "ErrorLogsFields" : { "name" : "fields", "in" : "query", "description" : "errorLogs fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,severity,error_state,module,line_no,message,creation_date" } }, "ErrorLogsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ErrorLogsIdResourceAttribute", "exampleSetFlag" : false } }, "EstimatesFields" : { "name" : "fields", "in" : "query", "description" : "estimates fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,estimate_id,version_number,wf_item_id,investigation_id,investigation_detail_id,damage_id,wf_notification_id,estimate_category_id,period_id,district_id,request_id,dispute_reason_id,dispute_estimate,accrued,count_against_quality_ratio,third_party_name,amount,default_amount,adjusted_amount,accrual_amount,difference_reason_id,estimate_date,change_reason,completed,approver,completed_by,completed_date,active,policy_drop_off_period_id,policy_drop_off,policy_drop_off_month,policy_drop_off_year,policy_drop_off_amount,prorated_payment_amount,attributes1,attributes2,attributes3,created_on,created_by,last_updated_on,last_updated_by,accrual_balance,cmsInvestigationDetail,investigation,district,financialPeriod,quickCValue,cmsRequest" } }, "EstimatesSort" : { "name" : "sort", "in" : "query", "description" : "estimates sort order (csv)", "schema" : { "type" : "string", "example" : "id,estimate_id,version_number,wf_item_id,investigation_id,investigation_detail_id,damage_id,wf_notification_id,estimate_category_id,period_id,district_id,request_id,dispute_reason_id,dispute_estimate,accrued,count_against_quality_ratio,third_party_name,amount,default_amount,adjusted_amount,accrual_amount,difference_reason_id,estimate_date,change_reason,completed,approver,completed_by,completed_date,active,policy_drop_off_period_id,policy_drop_off,policy_drop_off_month,policy_drop_off_year,policy_drop_off_amount,prorated_payment_amount,attributes1,attributes2,attributes3,created_on,created_by,last_updated_on,last_updated_by,accrual_balance,cmsInvestigationDetail,investigation,district,financialPeriod,quickCValue,cmsRequest", "exampleSetFlag" : true, "types" : [ "string" ] } }, "EstimatesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/EstimatesIdResourceAttribute", "exampleSetFlag" : false } }, "EstimatesInclude" : { "name" : "include", "in" : "query", "description" : "estimates relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CmsInvestigationDetails,Investigations,Districts,FinancialPeriods,QuickCodeValue,CmsRequests" } }, "ExcavatorInclude" : { "name" : "include", "in" : "query", "description" : "excavator relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Investigations" } }, "ExcavatorPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ExcavatorIdResourceAttribute", "exampleSetFlag" : false } }, "ExcavatorSort" : { "name" : "sort", "in" : "query", "description" : "excavator sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,contact_name,contact_phone_number,contact_email,created_on,created_by,last_updated_on,last_updated_by,investigations", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ExcavatorFields" : { "name" : "fields", "in" : "query", "description" : "excavator fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,contact_name,contact_phone_number,contact_email,created_on,created_by,last_updated_on,last_updated_by,investigations" } }, "FacilitiesInclude" : { "name" : "include", "in" : "query", "description" : "facilities relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "FlatRateCustomers,BillableCustomers,Damages,Investigations" } }, "FacilitiesFields" : { "name" : "fields", "in" : "query", "description" : "facilities fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,fd_damage_id,fd_investigation_id,fd_customer_name,flatRateCustomers,billableCustomers,damage,investigation" } }, "FacilitiesSort" : { "name" : "sort", "in" : "query", "description" : "facilities sort order (csv)", "schema" : { "type" : "string", "example" : "id,fd_damage_id,fd_investigation_id,fd_customer_name,flatRateCustomers,billableCustomers,damage,investigation", "exampleSetFlag" : true, "types" : [ "string" ] } }, "FacilitiesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/FacilitiesIdResourceAttribute", "exampleSetFlag" : false } }, "FeedsFields" : { "name" : "fields", "in" : "query", "description" : "feeds fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,feedname,queue_responses,notify_excavators,time_zone,feed_state,manual,parser_id,parser_on,low_volume_threshold,extensions,allow_combine,respond_trans,update_due_dates,billed_manually,call_after_hours,call_normal_hours,inactive,notify_reschedule,preferred,sticky_routing,reopen_on_update,re_call_normal_hours,re_call_after_hours,respect_state_boundaries,sqlserverized_routing,update_callout_policy,unlocatable,description,excav_notif_format,respond_attachments,respond_assignments,respond_excav_notif,excavator_reschedule,one_call_center,do_not_respond,unique_transmissions,re_call_events,notif_pattern_id,delay_minutes,attach_transmission,route_corporate_holidays,terms,transmissionsBase,transmissions,responseLogs" } }, "FeedsSort" : { "name" : "sort", "in" : "query", "description" : "feeds sort order (csv)", "schema" : { "type" : "string", "example" : "id,feedname,queue_responses,notify_excavators,time_zone,feed_state,manual,parser_id,parser_on,low_volume_threshold,extensions,allow_combine,respond_trans,update_due_dates,billed_manually,call_after_hours,call_normal_hours,inactive,notify_reschedule,preferred,sticky_routing,reopen_on_update,re_call_normal_hours,re_call_after_hours,respect_state_boundaries,sqlserverized_routing,update_callout_policy,unlocatable,description,excav_notif_format,respond_attachments,respond_assignments,respond_excav_notif,excavator_reschedule,one_call_center,do_not_respond,unique_transmissions,re_call_events,notif_pattern_id,delay_minutes,attach_transmission,route_corporate_holidays,terms,transmissionsBase,transmissions,responseLogs", "exampleSetFlag" : true, "types" : [ "string" ] } }, "FeedsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/FeedsIdResourceAttribute", "exampleSetFlag" : false } }, "FeedsInclude" : { "name" : "include", "in" : "query", "description" : "feeds relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Terms,TransmissionsBase,Transmissions,ResponseLogs" } }, "FinancialPeriodsInclude" : { "name" : "include", "in" : "query", "description" : "financialPeriods relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Estimates,AccrualSummaries,Accruals,Claims,LegalRisks,PolicyDropOffEstimates" } }, "FinancialPeriodsFields" : { "name" : "fields", "in" : "query", "description" : "financialPeriods fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,period_name,year,start_date,end_date,status_id,attribute1,attribute2,attribute3,created_on,created_by,last_updated_on,last_updated_by,closed_for_estimates,estimates,accrualSummaries,accruals,claims,legalRisks,policyDropOffEstimates" } }, "FinancialPeriodsSort" : { "name" : "sort", "in" : "query", "description" : "financialPeriods sort order (csv)", "schema" : { "type" : "string", "example" : "id,period_name,year,start_date,end_date,status_id,attribute1,attribute2,attribute3,created_on,created_by,last_updated_on,last_updated_by,closed_for_estimates,estimates,accrualSummaries,accruals,claims,legalRisks,policyDropOffEstimates", "exampleSetFlag" : true, "types" : [ "string" ] } }, "FinancialPeriodsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/FinancialPeriodsIdResourceAttribute", "exampleSetFlag" : false } }, "FlatRateCustomersFields" : { "name" : "fields", "in" : "query", "description" : "flatRateCustomers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,customer_id,utility_type_id,facility_type_id,facility_id,state_id,count_against_quality_guarantee,auto_approve_claims,approval_limit,active,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,cmsCustomer,facility,state" } }, "FlatRateCustomersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/FlatRateCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "FlatRateCustomersSort" : { "name" : "sort", "in" : "query", "description" : "flatRateCustomers sort order (csv)", "schema" : { "type" : "string", "example" : "id,customer_id,utility_type_id,facility_type_id,facility_id,state_id,count_against_quality_guarantee,auto_approve_claims,approval_limit,active,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,cmsCustomer,facility,state", "exampleSetFlag" : true, "types" : [ "string" ] } }, "FlatRateCustomersInclude" : { "name" : "include", "in" : "query", "description" : "flatRateCustomers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CmsCustomers,Facilities,States" } }, "IdeaKindsSort" : { "name" : "sort", "in" : "query", "description" : "ideaKinds sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,sort_order,active,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "IdeaKindsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/IdeaKindsIdResourceAttribute", "exampleSetFlag" : false } }, "IdeaKindsFields" : { "name" : "fields", "in" : "query", "description" : "ideaKinds fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,sort_order,active,created_on,created_by,last_updated_on,last_updated_by" } }, "IdeaKindsInclude" : { "name" : "include", "in" : "query", "description" : "ideaKinds relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "IdeasInclude" : { "name" : "include", "in" : "query", "description" : "ideas relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,IdeaKinds,Comments,Votes" } }, "IdeasFields" : { "name" : "fields", "in" : "query", "description" : "ideas fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,title,content,kind_id,author_id,created_on,created_by,last_updated_on,last_updated_by,active,approved_or_rejected_on,approved_or_rejected_by,approved,employee,kind,comments,votes" } }, "IdeasSort" : { "name" : "sort", "in" : "query", "description" : "ideas sort order (csv)", "schema" : { "type" : "string", "example" : "id,title,content,kind_id,author_id,created_on,created_by,last_updated_on,last_updated_by,active,approved_or_rejected_on,approved_or_rejected_by,approved,employee,kind,comments,votes", "exampleSetFlag" : true, "types" : [ "string" ] } }, "IdeasPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/IdeasIdResourceAttribute", "exampleSetFlag" : false } }, "InvestigationDetailLinesFields" : { "name" : "fields", "in" : "query", "description" : "investigationDetailLines fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,effective_start_date,effective_end_date,active,detail_id,contract_number,report_sent,billable_to_customer,count_against_quality_ratio,customer_claim_number,accepted_date,report_sent_date,created_on,created_by,last_updated_on,last_updated_by,att1,att2,att3,att4,att5,contract_id,cdc_code,adjuster_time,cmsInvestigationDetail" } }, "InvestigationDetailLinesSort" : { "name" : "sort", "in" : "query", "description" : "investigationDetailLines sort order (csv)", "schema" : { "type" : "string", "example" : "id,effective_start_date,effective_end_date,active,detail_id,contract_number,report_sent,billable_to_customer,count_against_quality_ratio,customer_claim_number,accepted_date,report_sent_date,created_on,created_by,last_updated_on,last_updated_by,att1,att2,att3,att4,att5,contract_id,cdc_code,adjuster_time,cmsInvestigationDetail", "exampleSetFlag" : true, "types" : [ "string" ] } }, "InvestigationDetailLinesInclude" : { "name" : "include", "in" : "query", "description" : "investigationDetailLines relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CmsInvestigationDetails" } }, "InvestigationDetailLinesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/InvestigationDetailLinesIdResourceAttribute", "exampleSetFlag" : false } }, "InvestigationDetailsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsIdResourceAttribute", "exampleSetFlag" : false } }, "InvestigationDetailsInclude" : { "name" : "include", "in" : "query", "description" : "investigationDetails relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Investigations,DamagePhotos,InvestigationDetailsVersions,PolicyDropOffEstimates,ClaimDetails" } }, "InvestigationDetailsSort" : { "name" : "sort", "in" : "query", "description" : "investigationDetails sort order (csv)", "schema" : { "type" : "string", "example" : "id,id_investigation_id,id_notification_id,id_damage_id,id_customer_id,id_account_level_customer_id,id_damage_customer,id_utility,id_facility,id_facility_type,id_locator_name,id_cause_factor,id_were_markings_visible,id_other_indicators,id_tolerence_zone,id_facility_damage,id_replacement_footage,id_contractor_assistance,id_contractor_equipment,id_facility_shown,id_record_numbers,inv_report_attachment_id,investigation,investigationReport,investigationDetailsVersions,policyDropOffEstimates,claimDetails", "exampleSetFlag" : true, "types" : [ "string" ] } }, "InvestigationDetailsFields" : { "name" : "fields", "in" : "query", "description" : "investigationDetails fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,id_investigation_id,id_notification_id,id_damage_id,id_customer_id,id_account_level_customer_id,id_damage_customer,id_utility,id_facility,id_facility_type,id_locator_name,id_cause_factor,id_were_markings_visible,id_other_indicators,id_tolerence_zone,id_facility_damage,id_replacement_footage,id_contractor_assistance,id_contractor_equipment,id_facility_shown,id_record_numbers,inv_report_attachment_id,investigation,investigationReport,investigationDetailsVersions,policyDropOffEstimates,claimDetails" } }, "InvestigationDetailsVersionsFields" : { "name" : "fields", "in" : "query", "description" : "investigationDetailsVersions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,detail_id,investigation_id,customer_id,utility_type_id,facility_type_id,facility_id,locator_id,created_on,created_by,last_updated_on,last_updated_by,wf_item_id,active,investigation_root_cause_id,completed,completed_by,completed_date,search_text,att1,att2,att3,att4,att5,changed_date,changed_by,investigation_version_id,investigationVersion,investigationDetail,investigation,locator,completedBy,changedBy,cmsCustomer" } }, "InvestigationDetailsVersionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/InvestigationDetailsVersionsIdResourceAttribute", "exampleSetFlag" : false } }, "InvestigationDetailsVersionsInclude" : { "name" : "include", "in" : "query", "description" : "investigationDetailsVersions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "InvestigationVersions,InvestigationDetails,Investigations,Employees,Employees,Employees,CmsCustomers" } }, "InvestigationDetailsVersionsSort" : { "name" : "sort", "in" : "query", "description" : "investigationDetailsVersions sort order (csv)", "schema" : { "type" : "string", "example" : "id,detail_id,investigation_id,customer_id,utility_type_id,facility_type_id,facility_id,locator_id,created_on,created_by,last_updated_on,last_updated_by,wf_item_id,active,investigation_root_cause_id,completed,completed_by,completed_date,search_text,att1,att2,att3,att4,att5,changed_date,changed_by,investigation_version_id,investigationVersion,investigationDetail,investigation,locator,completedBy,changedBy,cmsCustomer", "exampleSetFlag" : true, "types" : [ "string" ] } }, "InvestigationVersionsFields" : { "name" : "fields", "in" : "query", "description" : "investigationVersions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,investigation_id,damage_id,excavator_id,excavation_type_id,ticket_id,ticket_number,ticket_start_date,ticket_closed_date,inv_start_date,inv_end_date,dig_up_dmg_req,dig_up_dmg_ticket,pics_taken_by,approved,approved_date,approver,created_on,created_by,last_updated_on,last_updated_by,district_id,add_1,add_2,city,stateid,zip,county,countryid,cross_str1,cross_str2,excavator,locator_id,locator_first_nm,locator_last_nm,ticket_type,type_of_work,boring,completed,owner,completed_date,wf_item_id,search_text,latitude,longitude,geo_location,dots_number,customer_claim_number,changed_date,changed_by,post_approver_change,change_reason_id,change_reason_text,one_call_request_ticket_id,customer_claim_number_2,investigation,damage,approverEmployee,picsTakenByEmployee,investigationDetailsVersions" } }, "InvestigationVersionsInclude" : { "name" : "include", "in" : "query", "description" : "investigationVersions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Investigations,Damages,Employees,Employees,InvestigationDetailsVersions" } }, "InvestigationVersionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/InvestigationVersionsIdResourceAttribute", "exampleSetFlag" : false } }, "InvestigationVersionsSort" : { "name" : "sort", "in" : "query", "description" : "investigationVersions sort order (csv)", "schema" : { "type" : "string", "example" : "id,investigation_id,damage_id,excavator_id,excavation_type_id,ticket_id,ticket_number,ticket_start_date,ticket_closed_date,inv_start_date,inv_end_date,dig_up_dmg_req,dig_up_dmg_ticket,pics_taken_by,approved,approved_date,approver,created_on,created_by,last_updated_on,last_updated_by,district_id,add_1,add_2,city,stateid,zip,county,countryid,cross_str1,cross_str2,excavator,locator_id,locator_first_nm,locator_last_nm,ticket_type,type_of_work,boring,completed,owner,completed_date,wf_item_id,search_text,latitude,longitude,geo_location,dots_number,customer_claim_number,changed_date,changed_by,post_approver_change,change_reason_id,change_reason_text,one_call_request_ticket_id,customer_claim_number_2,investigation,damage,approverEmployee,picsTakenByEmployee,investigationDetailsVersions", "exampleSetFlag" : true, "types" : [ "string" ] } }, "InvestigationsSort" : { "name" : "sort", "in" : "query", "description" : "investigations sort order (csv)", "schema" : { "type" : "string", "example" : "id,damage_id,excavator_id,excavation_type_id,ticket_id,ticket_number,ticket_start_date,ticket_closed_date,inv_start_date,inv_end_date,dig_up_dmg_req,dig_up_dmg_ticket,pics_taken_by,approved,approved_date,approver,created_on,created_by,last_updated_on,last_updated_by,district_id,add_1,add_2,city,stateid,zip,county,countryid,cross_str1,cross_str2,excavator,locator_id,locator_first_nm,locator_last_nm,ticket_type,type_of_work,boring,completed,owner,completed_date,wf_item_id,search_text,latitude,longitude,geo_location,dots_number,customer_claim_number,customer_claim_number_2,post_approver_change,change_reason_id,change_reason_text,one_call_request_ticket_id,damage,excavationType,excavat,investigationDetails,investigationDetailsVersions,investigationVersions,cmsInvestigationDetails,employee,picsTakenEmployee,questionnaireAnswers,policyDropOffEstimates,estimates,questionaireAnswersVersions", "exampleSetFlag" : true, "types" : [ "string" ] } }, "InvestigationsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/InvestigationsIdResourceAttribute", "exampleSetFlag" : false } }, "InvestigationsInclude" : { "name" : "include", "in" : "query", "description" : "investigations relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Damages,QuickCodeValue,Excavator,InvestigationDetails,InvestigationDetailsVersions,InvestigationVersions,CmsInvestigationDetails,Employees,Employees,QuestionnaireAnswers,PolicyDropOffEstimates,Estimates" } }, "InvestigationsFields" : { "name" : "fields", "in" : "query", "description" : "investigations fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,damage_id,excavator_id,excavation_type_id,ticket_id,ticket_number,ticket_start_date,ticket_closed_date,inv_start_date,inv_end_date,dig_up_dmg_req,dig_up_dmg_ticket,pics_taken_by,approved,approved_date,approver,created_on,created_by,last_updated_on,last_updated_by,district_id,add_1,add_2,city,stateid,zip,county,countryid,cross_str1,cross_str2,excavator,locator_id,locator_first_nm,locator_last_nm,ticket_type,type_of_work,boring,completed,owner,completed_date,wf_item_id,search_text,latitude,longitude,geo_location,dots_number,customer_claim_number,customer_claim_number_2,post_approver_change,change_reason_id,change_reason_text,one_call_request_ticket_id,damage,excavationType,excavat,investigationDetails,investigationDetailsVersions,investigationVersions,cmsInvestigationDetails,employee,picsTakenEmployee,questionnaireAnswers,policyDropOffEstimates,estimates,questionaireAnswersVersions" } }, "JournalsFields" : { "name" : "fields", "in" : "query", "description" : "journals fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,journal_date,priv,active,category_id,app_bread_crumbs_id,pk1,pk2,pk3,journal_text,created_on,created_by,last_updated_on,last_updated_by,reminder_date,reminder_flag,created_by_id,last_updated_by_id,due_date,completed_date,createdBy,updatedBy" } }, "JournalsSort" : { "name" : "sort", "in" : "query", "description" : "journals sort order (csv)", "schema" : { "type" : "string", "example" : "id,journal_date,priv,active,category_id,app_bread_crumbs_id,pk1,pk2,pk3,journal_text,created_on,created_by,last_updated_on,last_updated_by,reminder_date,reminder_flag,created_by_id,last_updated_by_id,due_date,completed_date,createdBy,updatedBy", "exampleSetFlag" : true, "types" : [ "string" ] } }, "JournalsInclude" : { "name" : "include", "in" : "query", "description" : "journals relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,Employees" } }, "JournalsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/JournalsIdResourceAttribute", "exampleSetFlag" : false } }, "LawFirmsInclude" : { "name" : "include", "in" : "query", "description" : "lawFirms relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "LegalCases,LegalParties" } }, "LawFirmsFields" : { "name" : "fields", "in" : "query", "description" : "lawFirms fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,active,created_on,created_by,last_updated_on,last_updated_by,attribute1,attribute2,attribute3,legalCases,legalParties" } }, "LawFirmsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LawFirmsIdResourceAttribute", "exampleSetFlag" : false } }, "LawFirmsSort" : { "name" : "sort", "in" : "query", "description" : "lawFirms sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,active,created_on,created_by,last_updated_on,last_updated_by,attribute1,attribute2,attribute3,legalCases,legalParties", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LegalCasesInclude" : { "name" : "include", "in" : "query", "description" : "legalCases relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "LawFirms,LegalParties,CasesTypes,CasesSubtypes,LegalDamages,LegalRisks,ClaimDetails" } }, "LegalCasesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LegalCasesIdResourceAttribute", "exampleSetFlag" : false } }, "LegalCasesSort" : { "name" : "sort", "in" : "query", "description" : "legalCases sort order (csv)", "schema" : { "type" : "string", "example" : "id,cases_type_id,cases_sub_type_id,case_manager_id,insurance_adjuster_id,law_firm_id,legal_party_id,sued_by_type_id,law_firm_site_id,case_name,litigation_status_id,date_served,date_sent_to_attorney,matter_number,court_case_number,damage_agreed_date,insurance_claim,created_on,created_by,last_updated_on,last_updated_by,search_text,case_status,closed_date,trial_date,mediation_date,lawFirm,legalParty,casesType,casesSubtype,legalDamages,legalRisks,claimDetails", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LegalCasesFields" : { "name" : "fields", "in" : "query", "description" : "legalCases fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cases_type_id,cases_sub_type_id,case_manager_id,insurance_adjuster_id,law_firm_id,legal_party_id,sued_by_type_id,law_firm_site_id,case_name,litigation_status_id,date_served,date_sent_to_attorney,matter_number,court_case_number,damage_agreed_date,insurance_claim,created_on,created_by,last_updated_on,last_updated_by,search_text,case_status,closed_date,trial_date,mediation_date,lawFirm,legalParty,casesType,casesSubtype,legalDamages,legalRisks,claimDetails" } }, "LegalDamagesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LegalDamagesIdResourceAttribute", "exampleSetFlag" : false } }, "LegalDamagesFields" : { "name" : "fields", "in" : "query", "description" : "legalDamages fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,damage_id,case_id,created_on,created_by,last_updated_on,last_updated_by,damage,legalCase" } }, "LegalDamagesSort" : { "name" : "sort", "in" : "query", "description" : "legalDamages sort order (csv)", "schema" : { "type" : "string", "example" : "id,damage_id,case_id,created_on,created_by,last_updated_on,last_updated_by,damage,legalCase", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LegalDamagesInclude" : { "name" : "include", "in" : "query", "description" : "legalDamages relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Damages,LegalCases" } }, "LegalPartiesInclude" : { "name" : "include", "in" : "query", "description" : "legalParties relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "LegalCases,LawFirms" } }, "LegalPartiesSort" : { "name" : "sort", "in" : "query", "description" : "legalParties sort order (csv)", "schema" : { "type" : "string", "example" : "id,legal_party_type_id,law_firm_id,first_name,last_name,middle_name,preferred_name,address1,address2,city,state,zip,country,phone,mobile,fax,email,active,attribute1,attribute2,attribute3,created_on,created_by,last_updated_on,last_updated_by,countryid,stateid,legalCases,lawFirm", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LegalPartiesFields" : { "name" : "fields", "in" : "query", "description" : "legalParties fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,legal_party_type_id,law_firm_id,first_name,last_name,middle_name,preferred_name,address1,address2,city,state,zip,country,phone,mobile,fax,email,active,attribute1,attribute2,attribute3,created_on,created_by,last_updated_on,last_updated_by,countryid,stateid,legalCases,lawFirm" } }, "LegalPartiesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LegalPartiesIdResourceAttribute", "exampleSetFlag" : false } }, "LegalRisksPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LegalRisksIdResourceAttribute", "exampleSetFlag" : false } }, "LegalRisksFields" : { "name" : "fields", "in" : "query", "description" : "legalRisks fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,legal_risk_id,version_number,case_id,active,lawsuit_demand_amount,estimate,accrual_amount,accrual_flag,period_id,request_id,liability_age,settlement_reserve,expense_reserve,created_on,created_by,last_updated_on,last_updated_by,expense_accrual_balance,settlement_accrual_balance,legalCase,financialPeriod,cmsRequest" } }, "LegalRisksSort" : { "name" : "sort", "in" : "query", "description" : "legalRisks sort order (csv)", "schema" : { "type" : "string", "example" : "id,legal_risk_id,version_number,case_id,active,lawsuit_demand_amount,estimate,accrual_amount,accrual_flag,period_id,request_id,liability_age,settlement_reserve,expense_reserve,created_on,created_by,last_updated_on,last_updated_by,expense_accrual_balance,settlement_accrual_balance,legalCase,financialPeriod,cmsRequest", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LegalRisksInclude" : { "name" : "include", "in" : "query", "description" : "legalRisks relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "LegalCases,FinancialPeriods,CmsRequests" } }, "LoanedEmployeeAssetsInclude" : { "name" : "include", "in" : "query", "description" : "loanedEmployeeAssets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Assets" } }, "LoanedEmployeeAssetsFields" : { "name" : "fields", "in" : "query", "description" : "loanedEmployeeAssets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,employee_name,job_title,employee_id,home_supgroup,home_district,home_district_id,loan_supgroup,loan_district,loan_district_id,asset_id,version_number,asset_description,asset_type,serial_number,tag_number,asset_supgroup,asset_district,asset_district_id,asset_place,asset" } }, "LoanedEmployeeAssetsSort" : { "name" : "sort", "in" : "query", "description" : "loanedEmployeeAssets sort order (csv)", "schema" : { "type" : "string", "example" : "id,employee_name,job_title,employee_id,home_supgroup,home_district,home_district_id,loan_supgroup,loan_district,loan_district_id,asset_id,version_number,asset_description,asset_type,serial_number,tag_number,asset_supgroup,asset_district,asset_district_id,asset_place,asset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LoanedEmployeeAssetsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LoanedEmployeeAssetsIdResourceAttribute", "exampleSetFlag" : false } }, "LocateClosedSnapshotsSort" : { "name" : "sort", "in" : "query", "description" : "locateClosedSnapshots sort order (csv)", "schema" : { "type" : "string", "example" : "id,open,seqnum,closed_date,initial_status_date,client_id,utility_id,ticket_id,transmission_id,bucket_id,high_profile_id,latest_activity_id,legal_due_date,our_due_date,first_closing_activity_id,added_by_id,ticket_number,tickettype,parse_date,call_date,state,city,county,streetname,street_number,excavator,emergency,customer_id,customer,high_profile,past_due,project,ticket,bucket,transmissionDetail,transmissionExtra,transmissionBase,transmission,transmissionText,latestActivity,firstClosingActivity,term,termUtilityMap,activities,projectTicket,utility", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LocateClosedSnapshotsFields" : { "name" : "fields", "in" : "query", "description" : "locateClosedSnapshots fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,open,seqnum,closed_date,initial_status_date,client_id,utility_id,ticket_id,transmission_id,bucket_id,high_profile_id,latest_activity_id,legal_due_date,our_due_date,first_closing_activity_id,added_by_id,ticket_number,tickettype,parse_date,call_date,state,city,county,streetname,street_number,excavator,emergency,customer_id,customer,high_profile,past_due,project,ticket,bucket,transmissionDetail,transmissionExtra,transmissionBase,transmission,transmissionText,latestActivity,firstClosingActivity,term,termUtilityMap,activities,projectTicket,utility" } }, "LocateClosedSnapshotsInclude" : { "name" : "include", "in" : "query", "description" : "locateClosedSnapshots relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tickets,Buckets,TransmissionsDetail,TransmissionExtras,TransmissionsBase,Transmissions,TransmissionsText,Activities,Activities,Terms,TermUtilityMaps,Activities,ProjectTickets,Utilities" } }, "LocateClosedSnapshotsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LocateClosedSnapshotsIdResourceAttribute", "exampleSetFlag" : false } }, "LocateOpenSnapshotsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LocateOpenSnapshotsIdResourceAttribute", "exampleSetFlag" : false } }, "LocateOpenSnapshotsFields" : { "name" : "fields", "in" : "query", "description" : "locateOpenSnapshots fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,open,seqnum,closed_date,initial_status_date,client_id,ticket_id,transmission_id,bucket_id,high_profile_id,added_by_id,latest_activity_id,legal_due_date,our_due_date,utility_id,first_closing_activity_id,ticket_number,tickettype,parse_date,call_date,state,city,county,streetname,street_number,excavator,emergency,customer_id,customer,high_profile,past_due,project,ticket,bucket,transmissionDetail,transmissionExtra,transmissionBase,transmission,transmissionText,latestActivity,firstClosingActivity,term,termUtilityMap,activities,projectTicket,utility" } }, "LocateOpenSnapshotsInclude" : { "name" : "include", "in" : "query", "description" : "locateOpenSnapshots relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tickets,Buckets,TransmissionsDetail,TransmissionExtras,TransmissionsBase,Transmissions,TransmissionsText,Activities,Activities,Terms,TermUtilityMaps,Activities,ProjectTickets,Utilities" } }, "LocateOpenSnapshotsSort" : { "name" : "sort", "in" : "query", "description" : "locateOpenSnapshots sort order (csv)", "schema" : { "type" : "string", "example" : "id,open,seqnum,closed_date,initial_status_date,client_id,ticket_id,transmission_id,bucket_id,high_profile_id,added_by_id,latest_activity_id,legal_due_date,our_due_date,utility_id,first_closing_activity_id,ticket_number,tickettype,parse_date,call_date,state,city,county,streetname,street_number,excavator,emergency,customer_id,customer,high_profile,past_due,project,ticket,bucket,transmissionDetail,transmissionExtra,transmissionBase,transmission,transmissionText,latestActivity,firstClosingActivity,term,termUtilityMap,activities,projectTicket,utility", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LocatesSort" : { "name" : "sort", "in" : "query", "description" : "locates sort order (csv)", "schema" : { "type" : "string", "example" : "id,open,seqnum,closed_date,initial_status_date,client_id,ticket_id,transmission_id,bucket_id,high_profile_id,added_by_id,latest_activity_id,legal_due_date,our_due_date,utility_id,first_closing_activity_id,high_profile,past_due,project,ticket,bucket,transmissionDetail,transmissionExtra,transmissionBase,transmission,transmissionText,latestActivity,firstClosingActivity,term,termUtilityMap,activities,utility,projectTicket", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LocatesInclude" : { "name" : "include", "in" : "query", "description" : "locates relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tickets,Buckets,TransmissionsDetail,TransmissionExtras,TransmissionsBase,Transmissions,TransmissionsText,Activities,Activities,Terms,TermUtilityMaps,Activities,Utilities,ProjectTickets" } }, "LocatesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LocatesIdResourceAttribute", "exampleSetFlag" : false } }, "LocatesFields" : { "name" : "fields", "in" : "query", "description" : "locates fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,open,seqnum,closed_date,initial_status_date,client_id,ticket_id,transmission_id,bucket_id,high_profile_id,added_by_id,latest_activity_id,legal_due_date,our_due_date,utility_id,first_closing_activity_id,high_profile,past_due,project,ticket,bucket,transmissionDetail,transmissionExtra,transmissionBase,transmission,transmissionText,latestActivity,firstClosingActivity,term,termUtilityMap,activities,utility,projectTicket" } }, "LocationsSort" : { "name" : "sort", "in" : "query", "description" : "locations sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,location_type_id,address1,address2,city,state_id,zip,country_id,phone,mobile,fax,email,latitude,longitude,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,district_id,contact_name,districtLocations,country,state,assets,districts", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LocationsFields" : { "name" : "fields", "in" : "query", "description" : "locations fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,location_type_id,address1,address2,city,state_id,zip,country_id,phone,mobile,fax,email,latitude,longitude,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,notes,district_id,contact_name,districtLocations,country,state,assets,districts" } }, "LocationsInclude" : { "name" : "include", "in" : "query", "description" : "locations relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "DistrictLocations,Countries,States,Assets,Districts" } }, "LocationsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LocationsIdResourceAttribute", "exampleSetFlag" : false } }, "LocatorCheckinsFields" : { "name" : "fields", "in" : "query", "description" : "locatorCheckins fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,checkin_action,serial_number,usic_tag,asset_id,asset_version,created_on,created_by,last_updated_on,last_updated_by,reviewed_on,reviewed_by,notes,employee,asset" } }, "LocatorCheckinsSort" : { "name" : "sort", "in" : "query", "description" : "locatorCheckins sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,checkin_action,serial_number,usic_tag,asset_id,asset_version,created_on,created_by,last_updated_on,last_updated_by,reviewed_on,reviewed_by,notes,employee,asset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LocatorCheckinsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LocatorCheckinsIdResourceAttribute", "exampleSetFlag" : false } }, "LocatorCheckinsInclude" : { "name" : "include", "in" : "query", "description" : "locatorCheckins relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,Assets" } }, "LogosInclude" : { "name" : "include", "in" : "query", "description" : "logos relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "LogosPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/LogosIdResourceAttribute", "exampleSetFlag" : false } }, "LogosSort" : { "name" : "sort", "in" : "query", "description" : "logos sort order (csv)", "schema" : { "type" : "string", "example" : "id,customer_account_id,label,company_image,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "LogosFields" : { "name" : "fields", "in" : "query", "description" : "logos fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,customer_account_id,label,company_image,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by" } }, "MdmDevicesSort" : { "name" : "sort", "in" : "query", "description" : "mdmDevices sort order (csv)", "schema" : { "type" : "string", "example" : "device_group,username,serial_number,employee_id,district,id,network,phone_number,iccid,device_name,model,created_on,created_by,last_updated_on,last_updated_by,employee", "exampleSetFlag" : true, "types" : [ "string" ] } }, "MdmDevicesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/MdmDevicesIdResourceAttribute", "exampleSetFlag" : false } }, "MdmDevicesFields" : { "name" : "fields", "in" : "query", "description" : "mdmDevices fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "device_group,username,serial_number,employee_id,district,id,network,phone_number,iccid,device_name,model,created_on,created_by,last_updated_on,last_updated_by,employee" } }, "MdmDevicesInclude" : { "name" : "include", "in" : "query", "description" : "mdmDevices relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees" } }, "MessagesSort" : { "name" : "sort", "in" : "query", "description" : "messages sort order (csv)", "schema" : { "type" : "string", "example" : "id,message,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,employee_id,subject,message_preview,require_acknowledgement,application,unreadCount,readCount,sentCount,acknowledgedCount,employeeMessages,employee", "exampleSetFlag" : true, "types" : [ "string" ] } }, "MessagesInclude" : { "name" : "include", "in" : "query", "description" : "messages relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "EmployeeMessages,Employees" } }, "MessagesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/MessagesIdResourceAttribute", "exampleSetFlag" : false } }, "MessagesFields" : { "name" : "fields", "in" : "query", "description" : "messages fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,message,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,employee_id,subject,message_preview,require_acknowledgement,application,unreadCount,readCount,sentCount,acknowledgedCount,employeeMessages,employee" } }, "MessagesWithCountsFields" : { "name" : "fields", "in" : "query", "description" : "messagesWithCounts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,message,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,employee_id,subject,message_preview,require_acknowledgement,application,unreadCount,readCount,sentCount,acknowledgedCount,employee" } }, "MessagesWithCountsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/MessagesWithCountsIdResourceAttribute", "exampleSetFlag" : false } }, "MessagesWithCountsInclude" : { "name" : "include", "in" : "query", "description" : "messagesWithCounts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees" } }, "MessagesWithCountsSort" : { "name" : "sort", "in" : "query", "description" : "messagesWithCounts sort order (csv)", "schema" : { "type" : "string", "example" : "id,message,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,employee_id,subject,message_preview,require_acknowledgement,application,unreadCount,readCount,sentCount,acknowledgedCount,employee", "exampleSetFlag" : true, "types" : [ "string" ] } }, "NetmotionDevicesInclude" : { "name" : "include", "in" : "query", "description" : "netmotionDevices relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Assets" } }, "NetmotionDevicesSort" : { "name" : "sort", "in" : "query", "description" : "netmotionDevices sort order (csv)", "schema" : { "type" : "string", "example" : "device_group,disconnect_reason,last_connect,last_user,locality_version,mobility_version,serial_number,operating_system,id,registered,last_disconnect,created_on,created_by,last_updated_on,last_updated_by,asset_id,asset_category,asset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "NetmotionDevicesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/NetmotionDevicesIdResourceAttribute", "exampleSetFlag" : false } }, "NetmotionDevicesFields" : { "name" : "fields", "in" : "query", "description" : "netmotionDevices fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "device_group,disconnect_reason,last_connect,last_user,locality_version,mobility_version,serial_number,operating_system,id,registered,last_disconnect,created_on,created_by,last_updated_on,last_updated_by,asset_id,asset_category,asset" } }, "NotesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/NotesIdResourceAttribute", "exampleSetFlag" : false } }, "NotesSort" : { "name" : "sort", "in" : "query", "description" : "notes sort order (csv)", "schema" : { "type" : "string", "example" : "id,entity_kind,entity_id,entered_by_id,activity_id,whenentered,whenposted,type,note_text,excavator_note", "exampleSetFlag" : true, "types" : [ "string" ] } }, "NotesFields" : { "name" : "fields", "in" : "query", "description" : "notes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,entity_kind,entity_id,entered_by_id,activity_id,whenentered,whenposted,type,note_text,excavator_note" } }, "NotesInclude" : { "name" : "include", "in" : "query", "description" : "notes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "OpenTicketsFields" : { "name" : "fields", "in" : "query", "description" : "openTickets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,count,account_number,contract_number" } }, "OpenTicketsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/OpenTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "OpenTicketsInclude" : { "name" : "include", "in" : "query", "description" : "openTickets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "OpenTicketsSort" : { "name" : "sort", "in" : "query", "description" : "openTickets sort order (csv)", "schema" : { "type" : "string", "example" : "id,count,account_number,contract_number", "exampleSetFlag" : true, "types" : [ "string" ] } }, "OrganizationsInclude" : { "name" : "include", "in" : "query", "description" : "organizations relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "OrganizationsSort" : { "name" : "sort", "in" : "query", "description" : "organizations sort order (csv)", "schema" : { "type" : "string", "example" : "id,code,name,description,location_id,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "OrganizationsFields" : { "name" : "fields", "in" : "query", "description" : "organizations fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,code,name,description,location_id,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by" } }, "OrganizationsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/OrganizationsIdResourceAttribute", "exampleSetFlag" : false } }, "PasskeyCredentialsSort" : { "name" : "sort", "in" : "query", "description" : "passkeyCredentials sort order (csv)", "schema" : { "type" : "string", "example" : "id,passkeyuser_id,authenticator_type,credential_id,sign_count,attestation_object,client_data,transports,created_on,created_by,last_updated_on,last_updated_by,passkeyUser", "exampleSetFlag" : true, "types" : [ "string" ] } }, "PasskeyCredentialsFields" : { "name" : "fields", "in" : "query", "description" : "passkeyCredentials fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,passkeyuser_id,authenticator_type,credential_id,sign_count,attestation_object,client_data,transports,created_on,created_by,last_updated_on,last_updated_by,passkeyUser" } }, "PasskeyCredentialsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/PasskeyCredentialsIdResourceAttribute", "exampleSetFlag" : false } }, "PasskeyCredentialsInclude" : { "name" : "include", "in" : "query", "description" : "passkeyCredentials relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "PasskeyUsers" } }, "PasskeyUsersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/PasskeyUsersIdResourceAttribute", "exampleSetFlag" : false } }, "PasskeyUsersFields" : { "name" : "fields", "in" : "query", "description" : "passkeyUsers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,user_id,user_type,user_name,display_name,created_on,created_by,last_updated_on,last_updated_by,passkeyCredentials" } }, "PasskeyUsersSort" : { "name" : "sort", "in" : "query", "description" : "passkeyUsers sort order (csv)", "schema" : { "type" : "string", "example" : "id,user_id,user_type,user_name,display_name,created_on,created_by,last_updated_on,last_updated_by,passkeyCredentials", "exampleSetFlag" : true, "types" : [ "string" ] } }, "PasskeyUsersInclude" : { "name" : "include", "in" : "query", "description" : "passkeyUsers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "PasskeyCredentials" } }, "PayeeAddressesInclude" : { "name" : "include", "in" : "query", "description" : "payeeAddresses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Claims" } }, "PayeeAddressesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/PayeeAddressesIdResourceAttribute", "exampleSetFlag" : false } }, "PayeeAddressesSort" : { "name" : "sort", "in" : "query", "description" : "payeeAddresses sort order (csv)", "schema" : { "type" : "string", "example" : "claim_payee_id,payee,id,address,start_date,end_date,workday_vendor_number,claims", "exampleSetFlag" : true, "types" : [ "string" ] } }, "PayeeAddressesFields" : { "name" : "fields", "in" : "query", "description" : "payeeAddresses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "claim_payee_id,payee,id,address,start_date,end_date,workday_vendor_number,claims" } }, "PhotoCompliancesSort" : { "name" : "sort", "in" : "query", "description" : "photoCompliances sort order (csv)", "schema" : { "type" : "string", "example" : "id,purpose,message,distance,perimission,customer_name,customer,status_codes,model,check_visit_boundary,deleted,model_version,customer_facility_type", "exampleSetFlag" : true, "types" : [ "string" ] } }, "PhotoCompliancesFields" : { "name" : "fields", "in" : "query", "description" : "photoCompliances fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,purpose,message,distance,perimission,customer_name,customer,status_codes,model,check_visit_boundary,deleted,model_version,customer_facility_type" } }, "PhotoCompliancesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/PhotoCompliancesIdResourceAttribute", "exampleSetFlag" : false } }, "PhotoCompliancesInclude" : { "name" : "include", "in" : "query", "description" : "photoCompliances relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "PolicyDropOffEstimatesFields" : { "name" : "fields", "in" : "query", "description" : "policyDropOffEstimates fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,version_number,wf_item_id,investigation_id,investigation_detail_id,damage_id,wf_notification_id,estimate_category_id,period_id,district_id,request_id,dispute_reason_id,dispute_estimate,accrued,count_against_quality_ratio,third_party_name,amount,default_amount,adjusted_amount,accrual_amount,difference_reason_id,estimate_date,change_reason,completed,approver,completed_by,completed_date,active,policy_drop_off_period_id,policy_drop_off,policy_drop_off_month,policy_drop_off_year,policy_drop_off_amount,prorated_payment_amount,attributes1,attributes2,attributes3,created_on,created_by,last_updated_on,last_updated_by,accrual_balance,investigation,investigationDetail,damage,wfNotification,financialPeriod,quickCValue,cmsRequest,district" } }, "PolicyDropOffEstimatesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/PolicyDropOffEstimatesIdResourceAttribute", "exampleSetFlag" : false } }, "PolicyDropOffEstimatesInclude" : { "name" : "include", "in" : "query", "description" : "policyDropOffEstimates relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Investigations,InvestigationDetails,Damages,WfNotifications,FinancialPeriods,QuickCodeValue,CmsRequests,Districts" } }, "PolicyDropOffEstimatesSort" : { "name" : "sort", "in" : "query", "description" : "policyDropOffEstimates sort order (csv)", "schema" : { "type" : "string", "example" : "id,version_number,wf_item_id,investigation_id,investigation_detail_id,damage_id,wf_notification_id,estimate_category_id,period_id,district_id,request_id,dispute_reason_id,dispute_estimate,accrued,count_against_quality_ratio,third_party_name,amount,default_amount,adjusted_amount,accrual_amount,difference_reason_id,estimate_date,change_reason,completed,approver,completed_by,completed_date,active,policy_drop_off_period_id,policy_drop_off,policy_drop_off_month,policy_drop_off_year,policy_drop_off_amount,prorated_payment_amount,attributes1,attributes2,attributes3,created_on,created_by,last_updated_on,last_updated_by,accrual_balance,investigation,investigationDetail,damage,wfNotification,financialPeriod,quickCValue,cmsRequest,district", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ProfileLevelsFields" : { "name" : "fields", "in" : "query", "description" : "profileLevels fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,level_number,description,created_on,created_by,last_updated_on,last_updated_by,profileValues" } }, "ProfileLevelsSort" : { "name" : "sort", "in" : "query", "description" : "profileLevels sort order (csv)", "schema" : { "type" : "string", "example" : "id,level_number,description,created_on,created_by,last_updated_on,last_updated_by,profileValues", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ProfileLevelsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ProfileLevelsIdResourceAttribute", "exampleSetFlag" : false } }, "ProfileLevelsInclude" : { "name" : "include", "in" : "query", "description" : "profileLevels relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ProfileValues" } }, "ProfileValuesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ProfileValuesIdResourceAttribute", "exampleSetFlag" : false } }, "ProfileValuesSort" : { "name" : "sort", "in" : "query", "description" : "profileValues sort order (csv)", "schema" : { "type" : "string", "example" : "id,profile_id,profile_level_id,value,effective_start_date,effective_end_date,attribute1,value_data_type,created_on,created_by,last_updated_on,last_updated_by,profile,profileLevel", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ProfileValuesFields" : { "name" : "fields", "in" : "query", "description" : "profileValues fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,profile_id,profile_level_id,value,effective_start_date,effective_end_date,attribute1,value_data_type,created_on,created_by,last_updated_on,last_updated_by,profile,profileLevel" } }, "ProfileValuesInclude" : { "name" : "include", "in" : "query", "description" : "profileValues relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Profiles,ProfileLevels" } }, "ProfilesInclude" : { "name" : "include", "in" : "query", "description" : "profiles relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ProfileValues" } }, "ProfilesSort" : { "name" : "sort", "in" : "query", "description" : "profiles sort order (csv)", "schema" : { "type" : "string", "example" : "id,description,name,created_on,created_by,last_updated_on,last_updated_by,profileValues", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ProfilesFields" : { "name" : "fields", "in" : "query", "description" : "profiles fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,description,name,created_on,created_by,last_updated_on,last_updated_by,profileValues" } }, "ProfilesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ProfilesIdResourceAttribute", "exampleSetFlag" : false } }, "ProjectTicketsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ProjectTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "ProjectTicketsInclude" : { "name" : "include", "in" : "query", "description" : "projectTickets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tickets,Locates" } }, "ProjectTicketsFields" : { "name" : "fields", "in" : "query", "description" : "projectTickets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,identified_by_id,identified_date,ticket,locates" } }, "ProjectTicketsSort" : { "name" : "sort", "in" : "query", "description" : "projectTickets sort order (csv)", "schema" : { "type" : "string", "example" : "id,identified_by_id,identified_date,ticket,locates", "exampleSetFlag" : true, "types" : [ "string" ] } }, "PumpDevicePrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/PumpDeviceIdResourceAttribute", "exampleSetFlag" : false } }, "PumpDeviceInclude" : { "name" : "include", "in" : "query", "description" : "pumpDevice relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,Assets" } }, "PumpDeviceFields" : { "name" : "fields", "in" : "query", "description" : "pumpDevice fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,employee_id,pump_date,safety_screen_triggers_24,safety_screen_version,model,host_name,os_name,os_version,serial_number,ip_address,free_space,memory,mobile_number,imei,imed,available_gps_ports,last_gps_lock,created_on,created_by,employee,asset" } }, "PumpDeviceSort" : { "name" : "sort", "in" : "query", "description" : "pumpDevice sort order (csv)", "schema" : { "type" : "string", "example" : "id,employee_id,pump_date,safety_screen_triggers_24,safety_screen_version,model,host_name,os_name,os_version,serial_number,ip_address,free_space,memory,mobile_number,imei,imed,available_gps_ports,last_gps_lock,created_on,created_by,employee,asset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "PumpDevicesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/PumpDevicesIdResourceAttribute", "exampleSetFlag" : false } }, "PumpDevicesFields" : { "name" : "fields", "in" : "query", "description" : "pumpDevices fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,employee_id,pump_date,safety_screen_triggers_24,safety_screen_version,model,host_name,os_name,os_version,serial_number,ip_address,free_space,memory,mobile_number,imei,imed,available_gps_ports,last_gps_lock,created_on,created_by,employee,asset" } }, "PumpDevicesSort" : { "name" : "sort", "in" : "query", "description" : "pumpDevices sort order (csv)", "schema" : { "type" : "string", "example" : "id,employee_id,pump_date,safety_screen_triggers_24,safety_screen_version,model,host_name,os_name,os_version,serial_number,ip_address,free_space,memory,mobile_number,imei,imed,available_gps_ports,last_gps_lock,created_on,created_by,employee,asset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "PumpDevicesInclude" : { "name" : "include", "in" : "query", "description" : "pumpDevices relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,Assets" } }, "QuestionaireAnswersVersionsSort" : { "name" : "sort", "in" : "query", "description" : "questionaireAnswersVersions sort order (csv)", "schema" : { "type" : "string", "example" : "id,answer_id,investigation_id,investigation_detail_id,question_id,answer,created_on,created_by,last_updated_on,last_updated_by,changed_date,changed_by,investigation_version_id,questionnaireAnswer,investigation,questionnaireQuestion", "exampleSetFlag" : true, "types" : [ "string" ] } }, "QuestionaireAnswersVersionsFields" : { "name" : "fields", "in" : "query", "description" : "questionaireAnswersVersions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,answer_id,investigation_id,investigation_detail_id,question_id,answer,created_on,created_by,last_updated_on,last_updated_by,changed_date,changed_by,investigation_version_id,questionnaireAnswer,investigation,questionnaireQuestion" } }, "QuestionaireAnswersVersionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/QuestionaireAnswersVersionsIdResourceAttribute", "exampleSetFlag" : false } }, "QuestionaireAnswersVersionsInclude" : { "name" : "include", "in" : "query", "description" : "questionaireAnswersVersions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "QuestionnaireAnswers,Investigations,QuestionnaireQuestions" } }, "QuestionnaireAnswersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/QuestionnaireAnswersIdResourceAttribute", "exampleSetFlag" : false } }, "QuestionnaireAnswersSort" : { "name" : "sort", "in" : "query", "description" : "questionnaireAnswers sort order (csv)", "schema" : { "type" : "string", "example" : "id,investigation_id,investigation_detail_id,question_id,answer,created_on,created_by,last_updated_on,last_updated_by,investigation,questionnaireQuestion,questionaireAnswersVersions", "exampleSetFlag" : true, "types" : [ "string" ] } }, "QuestionnaireAnswersFields" : { "name" : "fields", "in" : "query", "description" : "questionnaireAnswers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,investigation_id,investigation_detail_id,question_id,answer,created_on,created_by,last_updated_on,last_updated_by,investigation,questionnaireQuestion,questionaireAnswersVersions" } }, "QuestionnaireAnswersInclude" : { "name" : "include", "in" : "query", "description" : "questionnaireAnswers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Investigations,QuestionnaireQuestions" } }, "QuestionnaireQuestionsSort" : { "name" : "sort", "in" : "query", "description" : "questionnaireQuestions sort order (csv)", "schema" : { "type" : "string", "example" : "id,code,description,label,seq,placement,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,master_question,criteria,type,visibility,required,questionnaireAnswers,questionaireAnswersVersions", "exampleSetFlag" : true, "types" : [ "string" ] } }, "QuestionnaireQuestionsFields" : { "name" : "fields", "in" : "query", "description" : "questionnaireQuestions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,code,description,label,seq,placement,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,master_question,criteria,type,visibility,required,questionnaireAnswers,questionaireAnswersVersions" } }, "QuestionnaireQuestionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/QuestionnaireQuestionsIdResourceAttribute", "exampleSetFlag" : false } }, "QuestionnaireQuestionsInclude" : { "name" : "include", "in" : "query", "description" : "questionnaireQuestions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "QuestionnaireAnswers" } }, "QuickCodeInclude" : { "name" : "include", "in" : "query", "description" : "quickCode relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "QuickCodeValue" } }, "QuickCodeFields" : { "name" : "fields", "in" : "query", "description" : "quickCode fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,code,display_name,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,quickCValues" } }, "QuickCodePrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/QuickCodeIdResourceAttribute", "exampleSetFlag" : false } }, "QuickCodeSort" : { "name" : "sort", "in" : "query", "description" : "quickCode sort order (csv)", "schema" : { "type" : "string", "example" : "id,code,display_name,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,quickCValues", "exampleSetFlag" : true, "types" : [ "string" ] } }, "QuickCodeValuePrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/QuickCodeValueIdResourceAttribute", "exampleSetFlag" : false } }, "QuickCodeValueInclude" : { "name" : "include", "in" : "query", "description" : "quickCodeValue relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "QuickCode,Estimates,Investigations" } }, "QuickCodeValueFields" : { "name" : "fields", "in" : "query", "description" : "quickCodeValue fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,quick_code_id,value,display_name,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,quickC,estimates,investigations" } }, "QuickCodeValueSort" : { "name" : "sort", "in" : "query", "description" : "quickCodeValue sort order (csv)", "schema" : { "type" : "string", "example" : "id,quick_code_id,value,display_name,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,quickC,estimates,investigations", "exampleSetFlag" : true, "types" : [ "string" ] } }, "QuickCodeValuesInclude" : { "name" : "include", "in" : "query", "description" : "quickCodeValues relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "QuickCodes" } }, "QuickCodeValuesFields" : { "name" : "fields", "in" : "query", "description" : "quickCodeValues fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,quick_code_id,value,display_name,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,quickCode" } }, "QuickCodeValuesSort" : { "name" : "sort", "in" : "query", "description" : "quickCodeValues sort order (csv)", "schema" : { "type" : "string", "example" : "id,quick_code_id,value,display_name,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,quickCode", "exampleSetFlag" : true, "types" : [ "string" ] } }, "QuickCodeValuesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/QuickCodeValuesIdResourceAttribute", "exampleSetFlag" : false } }, "QuickCodesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/QuickCodesIdResourceAttribute", "exampleSetFlag" : false } }, "QuickCodesSort" : { "name" : "sort", "in" : "query", "description" : "quickCodes sort order (csv)", "schema" : { "type" : "string", "example" : "id,code,display_name,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,quickCodeValues,attributeMappings", "exampleSetFlag" : true, "types" : [ "string" ] } }, "QuickCodesFields" : { "name" : "fields", "in" : "query", "description" : "quickCodes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,code,display_name,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,quickCodeValues,attributeMappings" } }, "QuickCodesInclude" : { "name" : "include", "in" : "query", "description" : "quickCodes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "QuickCodeValues,AttributeMappings" } }, "RandomEmployeePicksPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/RandomEmployeePicksIdResourceAttribute", "exampleSetFlag" : false } }, "RandomEmployeePicksFields" : { "name" : "fields", "in" : "query", "description" : "randomEmployeePicks fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,pick_date,created_on,created_by,last_updated_on,last_updated_by" } }, "RandomEmployeePicksSort" : { "name" : "sort", "in" : "query", "description" : "randomEmployeePicks sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,pick_date,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "RandomEmployeePicksInclude" : { "name" : "include", "in" : "query", "description" : "randomEmployeePicks relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "RepairReasonsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/RepairReasonsIdResourceAttribute", "exampleSetFlag" : false } }, "RepairReasonsFields" : { "name" : "fields", "in" : "query", "description" : "repairReasons fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,assets" } }, "RepairReasonsSort" : { "name" : "sort", "in" : "query", "description" : "repairReasons sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,notes,assets", "exampleSetFlag" : true, "types" : [ "string" ] } }, "RepairReasonsInclude" : { "name" : "include", "in" : "query", "description" : "repairReasons relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Assets" } }, "ReportDataTypesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ReportDataTypesIdResourceAttribute", "exampleSetFlag" : false } }, "ReportDataTypesSort" : { "name" : "sort", "in" : "query", "description" : "reportDataTypes sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,description,database_name,table_name,value_attribute,qualifier,data_source,model_name,filter_json,label,ui_value,ui_option,ui_option_custom,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ReportDataTypesFields" : { "name" : "fields", "in" : "query", "description" : "reportDataTypes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,description,database_name,table_name,value_attribute,qualifier,data_source,model_name,filter_json,label,ui_value,ui_option,ui_option_custom,created_on,created_by,last_updated_on,last_updated_by" } }, "ReportDataTypesInclude" : { "name" : "include", "in" : "query", "description" : "reportDataTypes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "ReportGroupSectionsSort" : { "name" : "sort", "in" : "query", "description" : "reportGroupSections sort order (csv)", "schema" : { "type" : "string", "example" : "id,report_group_id,name,required_roles,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,reportGroup,reports,reportsSectionOrders", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ReportGroupSectionsFields" : { "name" : "fields", "in" : "query", "description" : "reportGroupSections fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,report_group_id,name,required_roles,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,reportGroup,reports,reportsSectionOrders" } }, "ReportGroupSectionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ReportGroupSectionsIdResourceAttribute", "exampleSetFlag" : false } }, "ReportGroupSectionsInclude" : { "name" : "include", "in" : "query", "description" : "reportGroupSections relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ReportGroups,Reports,ReportsSectionOrders" } }, "ReportGroupsFields" : { "name" : "fields", "in" : "query", "description" : "reportGroups fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,title,icon,linkRoute,info,required_roles,num_columns,active,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,reportGroupSections" } }, "ReportGroupsSort" : { "name" : "sort", "in" : "query", "description" : "reportGroups sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,title,icon,linkRoute,info,required_roles,num_columns,active,created_on,created_by,last_updated_on,last_updated_by,eff_start_date,eff_end_date,reportGroupSections", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ReportGroupsInclude" : { "name" : "include", "in" : "query", "description" : "reportGroups relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ReportGroupSections" } }, "ReportGroupsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ReportGroupsIdResourceAttribute", "exampleSetFlag" : false } }, "ReportSourcesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ReportSourcesIdResourceAttribute", "exampleSetFlag" : false } }, "ReportSourcesFields" : { "name" : "fields", "in" : "query", "description" : "reportSources fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,data_source,active,required_roles,created_on,created_by,last_updated_on,last_updated_by,reports" } }, "ReportSourcesSort" : { "name" : "sort", "in" : "query", "description" : "reportSources sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,data_source,active,required_roles,created_on,created_by,last_updated_on,last_updated_by,reports", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ReportSourcesInclude" : { "name" : "include", "in" : "query", "description" : "reportSources relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Reports" } }, "ReportsInclude" : { "name" : "include", "in" : "query", "description" : "reports relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ReportSources" } }, "ReportsFields" : { "name" : "fields", "in" : "query", "description" : "reports fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,report_source_id,name,report_type,model,sql,owner,params,created_on,created_by,last_updated_on,last_updated_by,columns,required_roles,reportSource" } }, "ReportsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ReportsIdResourceAttribute", "exampleSetFlag" : false } }, "ReportsSort" : { "name" : "sort", "in" : "query", "description" : "reports sort order (csv)", "schema" : { "type" : "string", "example" : "id,report_source_id,name,report_type,model,sql,owner,params,created_on,created_by,last_updated_on,last_updated_by,columns,required_roles,reportSource", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ReportsSectionOrdersInclude" : { "name" : "include", "in" : "query", "description" : "reportsSectionOrders relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ReportGroupSections,Reports" } }, "ReportsSectionOrdersSort" : { "name" : "sort", "in" : "query", "description" : "reportsSectionOrders sort order (csv)", "schema" : { "type" : "string", "example" : "id,report_group_section_id,report_id,seq,reportGroupSection,report", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ReportsSectionOrdersFields" : { "name" : "fields", "in" : "query", "description" : "reportsSectionOrders fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,report_group_section_id,report_id,seq,reportGroupSection,report" } }, "ReportsSectionOrdersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ReportsSectionOrdersIdResourceAttribute", "exampleSetFlag" : false } }, "RequestsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/RequestsIdResourceAttribute", "exampleSetFlag" : false } }, "RequestsInclude" : { "name" : "include", "in" : "query", "description" : "requests relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees" } }, "RequestsSort" : { "name" : "sort", "in" : "query", "description" : "requests sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,userid,username,session_id,start_time,end_time,request_name,request_type,completed_status,param1,param2,param3,param4,param5,param6,param7,param8,param9,param10,created_on,created_by,last_updated_on,last_updated_by,employee", "exampleSetFlag" : true, "types" : [ "string" ] } }, "RequestsFields" : { "name" : "fields", "in" : "query", "description" : "requests fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,userid,username,session_id,start_time,end_time,request_name,request_type,completed_status,param1,param2,param3,param4,param5,param6,param7,param8,param9,param10,created_on,created_by,last_updated_on,last_updated_by,employee" } }, "ResponseLogsFields" : { "name" : "fields", "in" : "query", "description" : "responseLogs fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,activity_id,feed_id,when_sent,whenreplied,reply,success,transmission_id,codesent,title,seq_number,activity,feed,transmissionBase" } }, "ResponseLogsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ResponseLogsIdResourceAttribute", "exampleSetFlag" : false } }, "ResponseLogsInclude" : { "name" : "include", "in" : "query", "description" : "responseLogs relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Activities,Feeds,TransmissionsBase" } }, "ResponseLogsSort" : { "name" : "sort", "in" : "query", "description" : "responseLogs sort order (csv)", "schema" : { "type" : "string", "example" : "id,activity_id,feed_id,when_sent,whenreplied,reply,success,transmission_id,codesent,title,seq_number,activity,feed,transmissionBase", "exampleSetFlag" : true, "types" : [ "string" ] } }, "RoleAccessesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/RoleAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "RoleAccessesInclude" : { "name" : "include", "in" : "query", "description" : "roleAccesses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "UserRoles,RoleActions" } }, "RoleAccessesSort" : { "name" : "sort", "in" : "query", "description" : "roleAccesses sort order (csv)", "schema" : { "type" : "string", "example" : "id,role_id,effective_start_date,effective_end_date,action_id,p_add,p_delete,p_edit,p_view,created_on,created_by,last_updated_on,last_updated_by,userRole,roleAction", "exampleSetFlag" : true, "types" : [ "string" ] } }, "RoleAccessesFields" : { "name" : "fields", "in" : "query", "description" : "roleAccesses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,role_id,effective_start_date,effective_end_date,action_id,p_add,p_delete,p_edit,p_view,created_on,created_by,last_updated_on,last_updated_by,userRole,roleAction" } }, "RoleActionsFields" : { "name" : "fields", "in" : "query", "description" : "roleActions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,created_on,created_by,last_updated_on,last_updated_by,description,roleAccesses" } }, "RoleActionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/RoleActionsIdResourceAttribute", "exampleSetFlag" : false } }, "RoleActionsInclude" : { "name" : "include", "in" : "query", "description" : "roleActions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "RoleAccesses" } }, "RoleActionsSort" : { "name" : "sort", "in" : "query", "description" : "roleActions sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,created_on,created_by,last_updated_on,last_updated_by,description,roleAccesses", "exampleSetFlag" : true, "types" : [ "string" ] } }, "SchedulerJobStatusesSort" : { "name" : "sort", "in" : "query", "description" : "schedulerJobStatuses sort order (csv)", "schema" : { "type" : "string", "example" : "id,code,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,schedulerJobsInfo", "exampleSetFlag" : true, "types" : [ "string" ] } }, "SchedulerJobStatusesFields" : { "name" : "fields", "in" : "query", "description" : "schedulerJobStatuses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,code,description,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,schedulerJobsInfo" } }, "SchedulerJobStatusesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/SchedulerJobStatusesIdResourceAttribute", "exampleSetFlag" : false } }, "SchedulerJobStatusesInclude" : { "name" : "include", "in" : "query", "description" : "schedulerJobStatuses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "SchedulerJobs" } }, "SchedulerJobsSort" : { "name" : "sort", "in" : "query", "description" : "schedulerJobs sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,job_group,status_id,job_class,cron_expression,description,repeat_time,cron_job,time_zone,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,emp_id,attribute1,attribute2,attribute3,attribute4,attribute5,parameters,jobInfo,schedulerJobStatus,employee", "exampleSetFlag" : true, "types" : [ "string" ] } }, "SchedulerJobsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/SchedulerJobsIdResourceAttribute", "exampleSetFlag" : false } }, "SchedulerJobsInclude" : { "name" : "include", "in" : "query", "description" : "schedulerJobs relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "SchedulerJobStatuses,Employees" } }, "SchedulerJobsFields" : { "name" : "fields", "in" : "query", "description" : "schedulerJobs fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,job_group,status_id,job_class,cron_expression,description,repeat_time,cron_job,time_zone,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,emp_id,attribute1,attribute2,attribute3,attribute4,attribute5,parameters,jobInfo,schedulerJobStatus,employee" } }, "ServiceAccountLocateMatchesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ServiceAccountLocateMatchesIdResourceAttribute", "exampleSetFlag" : false } }, "ServiceAccountLocateMatchesFields" : { "name" : "fields", "in" : "query", "description" : "serviceAccountLocateMatches fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_id,lat,lon,ticket_number,tickettype,street_number,streetname,city,county,state,excavator,work_done_for,usic_ticket_type,typeofwork,caller_name,caller_phone,caller_fax,caller_email,cross_street1,cross_street2,emergency,short_notice,our_due_date,service_account_id,service_type,service_id,service_name,service_customer_id,service_expire_date,service_contact_name,service_contact_email,service_billing_type,service_feed_email,service_bore_footage,tkpServiceCustomer,serviceAccount,tkpTicket" } }, "ServiceAccountLocateMatchesInclude" : { "name" : "include", "in" : "query", "description" : "serviceAccountLocateMatches relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tkpcustomers,ServiceAccounts,TkpTickets" } }, "ServiceAccountLocateMatchesSort" : { "name" : "sort", "in" : "query", "description" : "serviceAccountLocateMatches sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_id,lat,lon,ticket_number,tickettype,street_number,streetname,city,county,state,excavator,work_done_for,usic_ticket_type,typeofwork,caller_name,caller_phone,caller_fax,caller_email,cross_street1,cross_street2,emergency,short_notice,our_due_date,service_account_id,service_type,service_id,service_name,service_customer_id,service_expire_date,service_contact_name,service_contact_email,service_billing_type,service_feed_email,service_bore_footage,tkpServiceCustomer,serviceAccount,tkpTicket", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ServiceAccountRulesFields" : { "name" : "fields", "in" : "query", "description" : "serviceAccountRules fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,service_account_id,state,excavator_include,excavator_exclude,work_done_for_include,work_done_for_exclude,external,deleted,created_date,modified_date,created_by_user_id,county,city,work_type,ticket_type,serviceAccount" } }, "ServiceAccountRulesSort" : { "name" : "sort", "in" : "query", "description" : "serviceAccountRules sort order (csv)", "schema" : { "type" : "string", "example" : "id,service_account_id,state,excavator_include,excavator_exclude,work_done_for_include,work_done_for_exclude,external,deleted,created_date,modified_date,created_by_user_id,county,city,work_type,ticket_type,serviceAccount", "exampleSetFlag" : true, "types" : [ "string" ] } }, "ServiceAccountRulesInclude" : { "name" : "include", "in" : "query", "description" : "serviceAccountRules relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ServiceAccounts" } }, "ServiceAccountRulesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ServiceAccountRulesIdResourceAttribute", "exampleSetFlag" : false } }, "ServiceAccountsFields" : { "name" : "fields", "in" : "query", "description" : "serviceAccounts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,service_type,service_id,service_name,customer_id,deleted,created_date,modified_date,expire_date,contact_name,contact_email,billing_type,serviceAccountRules,serviceAccountLocateMatches,tkpServiceCustomer" } }, "ServiceAccountsInclude" : { "name" : "include", "in" : "query", "description" : "serviceAccounts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ServiceAccountRules,ServiceAccountLocateMatches,Tkpcustomers" } }, "ServiceAccountsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ServiceAccountsIdResourceAttribute", "exampleSetFlag" : false } }, "ServiceAccountsSort" : { "name" : "sort", "in" : "query", "description" : "serviceAccounts sort order (csv)", "schema" : { "type" : "string", "example" : "id,service_type,service_id,service_name,customer_id,deleted,created_date,modified_date,expire_date,contact_name,contact_email,billing_type,serviceAccountRules,serviceAccountLocateMatches,tkpServiceCustomer", "exampleSetFlag" : true, "types" : [ "string" ] } }, "SessionsFields" : { "name" : "fields", "in" : "query", "description" : "sessions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_user_id,event,event_time,user" } }, "SessionsSort" : { "name" : "sort", "in" : "query", "description" : "sessions sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_user_id,event,event_time,user", "exampleSetFlag" : true, "types" : [ "string" ] } }, "SessionsInclude" : { "name" : "include", "in" : "query", "description" : "sessions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Users" } }, "SessionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/SessionsIdResourceAttribute", "exampleSetFlag" : false } }, "SmsMessageLogsFields" : { "name" : "fields", "in" : "query", "description" : "smsMessageLogs fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,message_id,employee_id,device_id,status_code,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,employee,smsMessage" } }, "SmsMessageLogsSort" : { "name" : "sort", "in" : "query", "description" : "smsMessageLogs sort order (csv)", "schema" : { "type" : "string", "example" : "id,message_id,employee_id,device_id,status_code,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,employee,smsMessage", "exampleSetFlag" : true, "types" : [ "string" ] } }, "SmsMessageLogsInclude" : { "name" : "include", "in" : "query", "description" : "smsMessageLogs relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,SmsMessages" } }, "SmsMessageLogsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/SmsMessageLogsIdResourceAttribute", "exampleSetFlag" : false } }, "SmsMessagesFields" : { "name" : "fields", "in" : "query", "description" : "smsMessages fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,message,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,smsMessageLogs" } }, "SmsMessagesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/SmsMessagesIdResourceAttribute", "exampleSetFlag" : false } }, "SmsMessagesInclude" : { "name" : "include", "in" : "query", "description" : "smsMessages relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "SmsMessageLogs" } }, "SmsMessagesSort" : { "name" : "sort", "in" : "query", "description" : "smsMessages sort order (csv)", "schema" : { "type" : "string", "example" : "id,message,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,smsMessageLogs", "exampleSetFlag" : true, "types" : [ "string" ] } }, "StatesFields" : { "name" : "fields", "in" : "query", "description" : "states fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,abbrev,countryid,created_on,created_by,last_updated_on,last_updated_by,locations,country" } }, "StatesInclude" : { "name" : "include", "in" : "query", "description" : "states relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Locations,Countries" } }, "StatesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/StatesIdResourceAttribute", "exampleSetFlag" : false } }, "StatesSort" : { "name" : "sort", "in" : "query", "description" : "states sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,abbrev,countryid,created_on,created_by,last_updated_on,last_updated_by,locations,country", "exampleSetFlag" : true, "types" : [ "string" ] } }, "StatusesSort" : { "name" : "sort", "in" : "query", "description" : "statuses sort order (csv)", "schema" : { "type" : "string", "example" : "id,code,description,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,employeeMessages", "exampleSetFlag" : true, "types" : [ "string" ] } }, "StatusesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/StatusesIdResourceAttribute", "exampleSetFlag" : false } }, "StatusesInclude" : { "name" : "include", "in" : "query", "description" : "statuses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "EmployeeMessages" } }, "StatusesFields" : { "name" : "fields", "in" : "query", "description" : "statuses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,code,description,effective_start_date,effective_end_date,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by,last_updated_on,last_updated_by,employeeMessages" } }, "StatusesCodePrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/StatusesCodeIdResourceAttribute", "exampleSetFlag" : false } }, "StatusesCodeInclude" : { "name" : "include", "in" : "query", "description" : "statusesCode relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Activities" } }, "StatusesCodeSort" : { "name" : "sort", "in" : "query", "description" : "statusesCode sort order (csv)", "schema" : { "type" : "string", "example" : "id,code,category,description,on_site,notify_excavator,next_status_id,deleted,reschedule,screening,activities", "exampleSetFlag" : true, "types" : [ "string" ] } }, "StatusesCodeFields" : { "name" : "fields", "in" : "query", "description" : "statusesCode fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,code,category,description,on_site,notify_excavator,next_status_id,deleted,reschedule,screening,activities" } }, "StorageVolumesInclude" : { "name" : "include", "in" : "query", "description" : "storageVolumes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Applications,Attachment" } }, "StorageVolumesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/StorageVolumesIdResourceAttribute", "exampleSetFlag" : false } }, "StorageVolumesSort" : { "name" : "sort", "in" : "query", "description" : "storageVolumes sort order (csv)", "schema" : { "type" : "string", "example" : "id,application_id,path,protocol,active,attribute1,attribute2,attribute3,created_on,created_by,last_updated_on,last_updated_by,application,attachments", "exampleSetFlag" : true, "types" : [ "string" ] } }, "StorageVolumesFields" : { "name" : "fields", "in" : "query", "description" : "storageVolumes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,application_id,path,protocol,active,attribute1,attribute2,attribute3,created_on,created_by,last_updated_on,last_updated_by,application,attachments" } }, "SupervisorGroupsInclude" : { "name" : "include", "in" : "query", "description" : "supervisorGroups relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Districts,Employees,EmployeesOnLoan,EmployeesActiveNoAssets,Assets" } }, "SupervisorGroupsSort" : { "name" : "sort", "in" : "query", "description" : "supervisorGroups sort order (csv)", "schema" : { "type" : "string", "example" : "id,sup_group_code,district_code,district_name,region,status,created_on,created_by,last_updated_on,dist,employees,employeesOnLoan,employeesActiveNoAsset,assets", "exampleSetFlag" : true, "types" : [ "string" ] } }, "SupervisorGroupsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/SupervisorGroupsIdResourceAttribute", "exampleSetFlag" : false } }, "SupervisorGroupsFields" : { "name" : "fields", "in" : "query", "description" : "supervisorGroups fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,sup_group_code,district_code,district_name,region,status,created_on,created_by,last_updated_on,dist,employees,employeesOnLoan,employeesActiveNoAsset,assets" } }, "TermUtilityMapsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TermUtilityMapsIdResourceAttribute", "exampleSetFlag" : false } }, "TermUtilityMapsInclude" : { "name" : "include", "in" : "query", "description" : "termUtilityMaps relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Locates,LocateOpenSnapshots,LocateClosedSnapshots" } }, "TermUtilityMapsFields" : { "name" : "fields", "in" : "query", "description" : "termUtilityMaps fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,utility_id,locate,locateOpenSnapshot,locateClosedSnapshot" } }, "TermUtilityMapsSort" : { "name" : "sort", "in" : "query", "description" : "termUtilityMaps sort order (csv)", "schema" : { "type" : "string", "example" : "id,utility_id,locate,locateOpenSnapshot,locateClosedSnapshot", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TermsFields" : { "name" : "fields", "in" : "query", "description" : "terms fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,code,feed_id,description,parse,charge_once,respond_code,do_not_respond,read_from_master_code,read_from_members,inactive,create_audit_item,do_not_close,unlocatable_term_id,unlocatable_status_id,add_text_only,feed,locates,locateClosedSnapshots,locateOpenSnapshots" } }, "TermsInclude" : { "name" : "include", "in" : "query", "description" : "terms relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Feeds,Locates,LocateClosedSnapshots,LocateOpenSnapshots" } }, "TermsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TermsIdResourceAttribute", "exampleSetFlag" : false } }, "TermsSort" : { "name" : "sort", "in" : "query", "description" : "terms sort order (csv)", "schema" : { "type" : "string", "example" : "id,code,feed_id,description,parse,charge_once,respond_code,do_not_respond,read_from_master_code,read_from_members,inactive,create_audit_item,do_not_close,unlocatable_term_id,unlocatable_status_id,add_text_only,feed,locates,locateClosedSnapshots,locateOpenSnapshots", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TicketClosedsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TicketClosedsIdResourceAttribute", "exampleSetFlag" : false } }, "TicketClosedsFields" : { "name" : "fields", "in" : "query", "description" : "ticketCloseds fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ticket_number,state,tickettype,work_date,transmit_date,our_due_date,closed_date,street_number,streetname,city,excavator,locator,utility,status,ticket_id,id,transmission_id,account_number,contract_number,lat,lon,project,supervisor,county,high_profile,locator_id,ticket,transmissionBase,transmission" } }, "TicketClosedsSort" : { "name" : "sort", "in" : "query", "description" : "ticketCloseds sort order (csv)", "schema" : { "type" : "string", "example" : "ticket_number,state,tickettype,work_date,transmit_date,our_due_date,closed_date,street_number,streetname,city,excavator,locator,utility,status,ticket_id,id,transmission_id,account_number,contract_number,lat,lon,project,supervisor,county,high_profile,locator_id,ticket,transmissionBase,transmission", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TicketClosedsInclude" : { "name" : "include", "in" : "query", "description" : "ticketCloseds relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tickets,TransmissionsBase,Transmissions" } }, "TicketRequestedServicesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TicketRequestedServicesIdResourceAttribute", "exampleSetFlag" : false } }, "TicketRequestedServicesInclude" : { "name" : "include", "in" : "query", "description" : "ticketRequestedServices relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "TicketRequestedServicesSort" : { "name" : "sort", "in" : "query", "description" : "ticketRequestedServices sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_id,service_type,service_id,high_priority,requested_service_date,assigned_by_rule_id,assigned_by_user_id,assigned_by_external_user,created_date,modified_date,bore_footage,tkpTicket", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TicketRequestedServicesFields" : { "name" : "fields", "in" : "query", "description" : "ticketRequestedServices fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_id,service_type,service_id,high_priority,requested_service_date,assigned_by_rule_id,assigned_by_user_id,assigned_by_external_user,created_date,modified_date,bore_footage,tkpTicket" } }, "TicketsInclude" : { "name" : "include", "in" : "query", "description" : "tickets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Locates,Visits,TicketsInfo,DueDateExtensions,TransmissionsBase,Transmissions,TransmissionsDetail,TkpDistricts,TicketCloseds,TkpAttachment,AttachmentsCategorized,ProjectTickets,AttachmentsWithNotifications,ActivityPathPoints" } }, "TicketsSort" : { "name" : "sort", "in" : "query", "description" : "tickets sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_number,our_due_date,closed_date,open,locate_list_cache,latest_transmission_id,open_emergency,ticket_contact_id,excavator_contact_id,ordered_by_contact_id,bill_to_contact_id,ticket_invoice_signature_id,billed_manually,risk_score,ticket_district_id,ticket_sup_group_id,locates,visits,ticketsInfo,dueDateExtensions,transmissionBase,transmission,transmissionDetail,tkpDistrict,cpClosedTickets,tkpAttachments,attachmentsCategorized,projectTicket,tkpAttachmentsWithNotifications,activityPathPoints,linkedTickets", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TicketsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TicketsIdResourceAttribute", "exampleSetFlag" : false } }, "TicketsFields" : { "name" : "fields", "in" : "query", "description" : "tickets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_number,our_due_date,closed_date,open,locate_list_cache,latest_transmission_id,open_emergency,ticket_contact_id,excavator_contact_id,ordered_by_contact_id,bill_to_contact_id,ticket_invoice_signature_id,billed_manually,risk_score,ticket_district_id,ticket_sup_group_id,locates,visits,ticketsInfo,dueDateExtensions,transmissionBase,transmission,transmissionDetail,tkpDistrict,cpClosedTickets,tkpAttachments,attachmentsCategorized,projectTicket,tkpAttachmentsWithNotifications,activityPathPoints,linkedTickets" } }, "TicketsInfoInclude" : { "name" : "include", "in" : "query", "description" : "ticketsInfo relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tickets" } }, "TicketsInfoSort" : { "name" : "sort", "in" : "query", "description" : "ticketsInfo sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_id,added_by_id,effective_date,expires_date,emergency,meet,lot_type,lot_ownership,region,work_time_type,meet_date,area_id,master_contractor,eta,sup_cn_reviewed,rms_cn_reviewed,rms_cn_map_sent,rms_cn_deferred,rms_eet_assigned,ticket", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TicketsInfoFields" : { "name" : "fields", "in" : "query", "description" : "ticketsInfo fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_id,added_by_id,effective_date,expires_date,emergency,meet,lot_type,lot_ownership,region,work_time_type,meet_date,area_id,master_contractor,eta,sup_cn_reviewed,rms_cn_reviewed,rms_cn_map_sent,rms_cn_deferred,rms_eet_assigned,ticket" } }, "TicketsInfoPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TicketsInfoIdResourceAttribute", "exampleSetFlag" : false } }, "TkpAttachmentPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TkpAttachmentIdResourceAttribute", "exampleSetFlag" : false } }, "TkpAttachmentFields" : { "name" : "fields", "in" : "query", "description" : "tkpAttachment fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "attachment_type,id,attachment_id,entity_kind,entity_id,attached_by,when_attached,when_uploaded,file_name,file_size,hash,status,lat,lon,created_date,created_time,original_ticket_number,attachmentTag,ticket" } }, "TkpAttachmentInclude" : { "name" : "include", "in" : "query", "description" : "tkpAttachment relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "TkpAttachmentTags,Tickets" } }, "TkpAttachmentSort" : { "name" : "sort", "in" : "query", "description" : "tkpAttachment sort order (csv)", "schema" : { "type" : "string", "example" : "attachment_type,id,attachment_id,entity_kind,entity_id,attached_by,when_attached,when_uploaded,file_name,file_size,hash,status,lat,lon,created_date,created_time,original_ticket_number,attachmentTag,ticket", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TkpAttachmentTagsInclude" : { "name" : "include", "in" : "query", "description" : "tkpAttachmentTags relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "TkpAttachmentTagsSort" : { "name" : "sort", "in" : "query", "description" : "tkpAttachmentTags sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_id,queued_at,respond,processed_at,created_date,created_time,lat,lon,format,geom,user_id,utility_electric,utility_telecom,utility_gas,utility_water,utility_sewer,flags_electric,flags_gas,flags_sewer,flags_telecom,flags_water,nearby_electric,nearby_gas,nearby_sewer,nearby_telecom,nearby_water,clear_electric,clear_gas,clear_sewer,clear_telecom,clear_water,extra_damage,extra_survey_pink,extra_whitelining,infra_fire_hydrant,infra_manhole,infra_utility_hookup,infra_pedestal_small,infra_pedestal_large,infra_meter_gas,infra_meter_water,infra_meter_electric,infra_pipeline_poles,infra_hvac,infra_bollard,infra_erosion_wattle,infra_garden_hose,infra_cable_debris,infra_electric_wires,infra_guy_wire,road_curb_red,road_curb_white,road_curb_yellow,road_curb_blue,road_line_yellow,road_line_blue,road_line_white,road_line_red,road_crosswalk,equip_cones,equip_locator,equip_construction,equip_usic_truck,scene_human,scene_trash_box,scene_caution_tape,scene_protective_fence,scene_screenshot,type_residential,type_commercial,type_roadway,type_construction,type_rural,type_city,type_new_homes,weather_rain,weather_snow,weather_dry,weather_dark,ground_grass,ground_dry_grass,ground_mulch,ground_dirt,ground_construction_mud,ground_gravel,ground_asphalt,ground_concrete,ground_pavers,ground_fallen_leaves,ground_snow", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TkpAttachmentTagsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TkpAttachmentTagsIdResourceAttribute", "exampleSetFlag" : false } }, "TkpAttachmentTagsFields" : { "name" : "fields", "in" : "query", "description" : "tkpAttachmentTags fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_id,queued_at,respond,processed_at,created_date,created_time,lat,lon,format,geom,user_id,utility_electric,utility_telecom,utility_gas,utility_water,utility_sewer,flags_electric,flags_gas,flags_sewer,flags_telecom,flags_water,nearby_electric,nearby_gas,nearby_sewer,nearby_telecom,nearby_water,clear_electric,clear_gas,clear_sewer,clear_telecom,clear_water,extra_damage,extra_survey_pink,extra_whitelining,infra_fire_hydrant,infra_manhole,infra_utility_hookup,infra_pedestal_small,infra_pedestal_large,infra_meter_gas,infra_meter_water,infra_meter_electric,infra_pipeline_poles,infra_hvac,infra_bollard,infra_erosion_wattle,infra_garden_hose,infra_cable_debris,infra_electric_wires,infra_guy_wire,road_curb_red,road_curb_white,road_curb_yellow,road_curb_blue,road_line_yellow,road_line_blue,road_line_white,road_line_red,road_crosswalk,equip_cones,equip_locator,equip_construction,equip_usic_truck,scene_human,scene_trash_box,scene_caution_tape,scene_protective_fence,scene_screenshot,type_residential,type_commercial,type_roadway,type_construction,type_rural,type_city,type_new_homes,weather_rain,weather_snow,weather_dry,weather_dark,ground_grass,ground_dry_grass,ground_mulch,ground_dirt,ground_construction_mud,ground_gravel,ground_asphalt,ground_concrete,ground_pavers,ground_fallen_leaves,ground_snow" } }, "TkpCustomersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TkpCustomersIdResourceAttribute", "exampleSetFlag" : false } }, "TkpCustomersSort" : { "name" : "sort", "in" : "query", "description" : "tkpCustomers sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,account_name,account_number,utilities", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TkpCustomersInclude" : { "name" : "include", "in" : "query", "description" : "tkpCustomers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Utilities" } }, "TkpCustomersFields" : { "name" : "fields", "in" : "query", "description" : "tkpCustomers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,account_name,account_number,utilities" } }, "TkpDistrictsFields" : { "name" : "fields", "in" : "query", "description" : "tkpDistricts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,district_code,company_id,inactive,district_abbrev,district_name,time_zone,lunch_lower_limit,lunch_upper_limit,clock_start,work_hours_id,productivity_goal,client_min_verison,client_pref_version,work_code,address1,address2,city,state,zip,org_region_id,tickets,visits,usrs" } }, "TkpDistrictsInclude" : { "name" : "include", "in" : "query", "description" : "tkpDistricts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tickets,Visits,Usrs" } }, "TkpDistrictsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TkpDistrictsIdResourceAttribute", "exampleSetFlag" : false } }, "TkpDistrictsSort" : { "name" : "sort", "in" : "query", "description" : "tkpDistricts sort order (csv)", "schema" : { "type" : "string", "example" : "id,district_code,company_id,inactive,district_abbrev,district_name,time_zone,lunch_lower_limit,lunch_upper_limit,clock_start,work_hours_id,productivity_goal,client_min_verison,client_pref_version,work_code,address1,address2,city,state,zip,org_region_id,tickets,visits,usrs", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TkpTicketsFields" : { "name" : "fields", "in" : "query", "description" : "tkpTickets fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_number,our_due_date,closed_date,open,locate_list_cache,latest_transmission_id,open_emergency,ticket_contact_id,excavator_contact_id,ordered_by_contact_id,bill_to_contact_id,ticket_invoice_signature_id,billed_manually,risk_score,ticket_district_id,ticket_sup_group_id,serviceAccountLocateMatches" } }, "TkpTicketsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TkpTicketsIdResourceAttribute", "exampleSetFlag" : false } }, "TkpTicketsSort" : { "name" : "sort", "in" : "query", "description" : "tkpTickets sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_number,our_due_date,closed_date,open,locate_list_cache,latest_transmission_id,open_emergency,ticket_contact_id,excavator_contact_id,ordered_by_contact_id,bill_to_contact_id,ticket_invoice_signature_id,billed_manually,risk_score,ticket_district_id,ticket_sup_group_id,serviceAccountLocateMatches", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TkpTicketsInclude" : { "name" : "include", "in" : "query", "description" : "tkpTickets relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ServiceAccountLocateMatches" } }, "TkpcustomersFields" : { "name" : "fields", "in" : "query", "description" : "tkpcustomers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,account_name,account_number,serviceAccounts,serviceAccountLocateMatches" } }, "TkpcustomersInclude" : { "name" : "include", "in" : "query", "description" : "tkpcustomers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "ServiceAccounts,ServiceAccountLocateMatches" } }, "TkpcustomersSort" : { "name" : "sort", "in" : "query", "description" : "tkpcustomers sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,account_name,account_number,serviceAccounts,serviceAccountLocateMatches", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TkpcustomersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TkpcustomersIdResourceAttribute", "exampleSetFlag" : false } }, "TokensSort" : { "name" : "sort", "in" : "query", "description" : "tokens sort order (csv)", "schema" : { "type" : "string", "example" : "id,token,user_id,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,user,userAccesses", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TokensInclude" : { "name" : "include", "in" : "query", "description" : "tokens relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "WsUsers,WsUserAccesses" } }, "TokensPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TokensIdResourceAttribute", "exampleSetFlag" : false } }, "TokensFields" : { "name" : "fields", "in" : "query", "description" : "tokens fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,token,user_id,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,user,userAccesses" } }, "TransmissionExtrasPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TransmissionExtrasIdResourceAttribute", "exampleSetFlag" : false } }, "TransmissionExtrasSort" : { "name" : "sort", "in" : "query", "description" : "transmissionExtras sort order (csv)", "schema" : { "type" : "string", "example" : "id,marking_instructions,cross_ref,township,original_ticket_number,original_ticket_id,contact,zip,identifier,depth,contract_seq,excavation_means,excavator_state,excavator_zip,sidewalk,in_street,remark,driving_instructions,duration,single_address,contact_mobile,whitelined,locates", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TransmissionExtrasInclude" : { "name" : "include", "in" : "query", "description" : "transmissionExtras relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Locates" } }, "TransmissionExtrasFields" : { "name" : "fields", "in" : "query", "description" : "transmissionExtras fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,marking_instructions,cross_ref,township,original_ticket_number,original_ticket_id,contact,zip,identifier,depth,contract_seq,excavation_means,excavator_state,excavator_zip,sidewalk,in_street,remark,driving_instructions,duration,single_address,contact_mobile,whitelined,locates" } }, "TransmissionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TransmissionsIdResourceAttribute", "exampleSetFlag" : false } }, "TransmissionsSort" : { "name" : "sort", "in" : "query", "description" : "transmissions sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_id,ticket_number,message_type,trans_number,transmit_date,call_date,work_date,parse_date,county,city,state,streetname,street_number,emergency,short_notice,tickettype,after_hours,feed_id,meet,meet_date,meet_code,transmitted_legal_due_date,transmission_type,added_by_id,service_area_code,master_code,billing_code,download_time,subdivision,street_dir,typeofwork,lead_time,raw_image,sourcefilename,caller_name,caller_phone,caller_fax,caller_email,excavator_address_1,excavator_city,work_done_for,excavator,maplocation,mapbook,description,blasting,lat,lon,version_number,cross_street1,cross_street2,boring,usic_ticket_type,locates,tickets,cpClosedTickets,feed", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TransmissionsFields" : { "name" : "fields", "in" : "query", "description" : "transmissions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_id,ticket_number,message_type,trans_number,transmit_date,call_date,work_date,parse_date,county,city,state,streetname,street_number,emergency,short_notice,tickettype,after_hours,feed_id,meet,meet_date,meet_code,transmitted_legal_due_date,transmission_type,added_by_id,service_area_code,master_code,billing_code,download_time,subdivision,street_dir,typeofwork,lead_time,raw_image,sourcefilename,caller_name,caller_phone,caller_fax,caller_email,excavator_address_1,excavator_city,work_done_for,excavator,maplocation,mapbook,description,blasting,lat,lon,version_number,cross_street1,cross_street2,boring,usic_ticket_type,locates,tickets,cpClosedTickets,feed" } }, "TransmissionsInclude" : { "name" : "include", "in" : "query", "description" : "transmissions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Locates,Tickets,TicketCloseds,Feeds" } }, "TransmissionsBaseFields" : { "name" : "fields", "in" : "query", "description" : "transmissionsBase fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_id,ticket_number,message_type,trans_number,transmit_date,call_date,work_date,parse_date,county,city,state,streetname,street_number,emergency,short_notice,tickettype,after_hours,feed_id,meet,meet_date,meet_code,transmitted_legal_due_date,transmission_type,added_by_id,service_area_code,master_code,billing_code,download_time,subdivision,street_dir,typeofwork,lead_time,blasting,usic_ticket_type,transmissionDetail,transmissionText,transmissionExtra,locates,tickets,cpClosedTickets,responseLogs,feed" } }, "TransmissionsBaseInclude" : { "name" : "include", "in" : "query", "description" : "transmissionsBase relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "TransmissionsDetail,TransmissionsText,TransmissionExtras,Locates,Tickets,TicketCloseds,ResponseLogs,Feeds" } }, "TransmissionsBasePrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TransmissionsBaseIdResourceAttribute", "exampleSetFlag" : false } }, "TransmissionsBaseSort" : { "name" : "sort", "in" : "query", "description" : "transmissionsBase sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_id,ticket_number,message_type,trans_number,transmit_date,call_date,work_date,parse_date,county,city,state,streetname,street_number,emergency,short_notice,tickettype,after_hours,feed_id,meet,meet_date,meet_code,transmitted_legal_due_date,transmission_type,added_by_id,service_area_code,master_code,billing_code,download_time,subdivision,street_dir,typeofwork,lead_time,blasting,usic_ticket_type,transmissionDetail,transmissionText,transmissionExtra,locates,tickets,cpClosedTickets,responseLogs,feed", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TransmissionsDetailFields" : { "name" : "fields", "in" : "query", "description" : "transmissionsDetail fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,sourcefilename,caller_name,caller_phone,caller_fax,caller_email,excavator_address_1,excavator_city,work_done_for,excavator,maplocation,description,mapbook,lat,lon,version_number,cross_street1,cross_street2,boring,transmissionBase,transmissionText,tickets,locates,digAreas" } }, "TransmissionsDetailInclude" : { "name" : "include", "in" : "query", "description" : "transmissionsDetail relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "TransmissionsBase,TransmissionsText,Tickets,Locates,DigAreas" } }, "TransmissionsDetailSort" : { "name" : "sort", "in" : "query", "description" : "transmissionsDetail sort order (csv)", "schema" : { "type" : "string", "example" : "id,sourcefilename,caller_name,caller_phone,caller_fax,caller_email,excavator_address_1,excavator_city,work_done_for,excavator,maplocation,description,mapbook,lat,lon,version_number,cross_street1,cross_street2,boring,transmissionBase,transmissionText,tickets,locates,digAreas", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TransmissionsDetailPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TransmissionsDetailIdResourceAttribute", "exampleSetFlag" : false } }, "TransmissionsTextPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/TransmissionsTextIdResourceAttribute", "exampleSetFlag" : false } }, "TransmissionsTextInclude" : { "name" : "include", "in" : "query", "description" : "transmissionsText relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "TransmissionsDetail,TransmissionsBase,Locates" } }, "TransmissionsTextSort" : { "name" : "sort", "in" : "query", "description" : "transmissionsText sort order (csv)", "schema" : { "type" : "string", "example" : "id,raw_image,transmissionDetail,transmissionBase,locates", "exampleSetFlag" : true, "types" : [ "string" ] } }, "TransmissionsTextFields" : { "name" : "fields", "in" : "query", "description" : "transmissionsText fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,raw_image,transmissionDetail,transmissionBase,locates" } }, "UserAccessesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "UserAccessesFields" : { "name" : "fields", "in" : "query", "description" : "userAccesses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_user_id,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by,customer_account_id,customer_contract_id,customer_states,user,customerContract,customerAccount" } }, "UserAccessesInclude" : { "name" : "include", "in" : "query", "description" : "userAccesses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Users,CustomerContracts,CustomerAccounts" } }, "UserAccessesSort" : { "name" : "sort", "in" : "query", "description" : "userAccesses sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_user_id,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by,customer_account_id,customer_contract_id,customer_states,user,customerContract,customerAccount", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserAccountAccessViewPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserAccountAccessViewIdResourceAttribute", "exampleSetFlag" : false } }, "UserAccountAccessViewSort" : { "name" : "sort", "in" : "query", "description" : "userAccountAccessView sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_user_id,cp_user_name,account_number,customer_account_id", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserAccountAccessViewInclude" : { "name" : "include", "in" : "query", "description" : "userAccountAccessView relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UserAccountAccessViewFields" : { "name" : "fields", "in" : "query", "description" : "userAccountAccessView fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_user_id,cp_user_name,account_number,customer_account_id" } }, "UserAccountContractAccessesSort" : { "name" : "sort", "in" : "query", "description" : "userAccountContractAccesses sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_user_id,cp_user_name,account_number,contract_number,customer_account_id,customer_contract_id,contract_name,customerContract,customerAccount", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserAccountContractAccessesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserAccountContractAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "UserAccountContractAccessesInclude" : { "name" : "include", "in" : "query", "description" : "userAccountContractAccesses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CustomerContracts,CustomerAccounts" } }, "UserAccountContractAccessesFields" : { "name" : "fields", "in" : "query", "description" : "userAccountContractAccesses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_user_id,cp_user_name,account_number,contract_number,customer_account_id,customer_contract_id,contract_name,customerContract,customerAccount" } }, "UserContactsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserContactsIdResourceAttribute", "exampleSetFlag" : false } }, "UserContactsSort" : { "name" : "sort", "in" : "query", "description" : "userContacts sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_user_id,cp_user_name,cp_district_code,cp_district_abbr,cp_district_name,usic_contact_id,district_id,district_state,address_line1,address_line2,address_line3,city,state,country,dm_name,dm_email,dm_phone_no,hr,hr_phone_no,rd_name,rd_phone_no,rd_email,it_support,it_support_phone_no,sales_contact,sales_phone_no,sales_email,general_contact,general_phone_no,general_email,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserContactsFields" : { "name" : "fields", "in" : "query", "description" : "userContacts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_user_id,cp_user_name,cp_district_code,cp_district_abbr,cp_district_name,usic_contact_id,district_id,district_state,address_line1,address_line2,address_line3,city,state,country,dm_name,dm_email,dm_phone_no,hr,hr_phone_no,rd_name,rd_phone_no,rd_email,it_support,it_support_phone_no,sales_contact,sales_phone_no,sales_email,general_contact,general_phone_no,general_email,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by" } }, "UserContactsInclude" : { "name" : "include", "in" : "query", "description" : "userContacts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UserDataAccessViewFields" : { "name" : "fields", "in" : "query", "description" : "userDataAccessView fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,district_id,district_name,sup_group_code,region" } }, "UserDataAccessViewInclude" : { "name" : "include", "in" : "query", "description" : "userDataAccessView relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UserDataAccessViewPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserDataAccessViewIdResourceAttribute", "exampleSetFlag" : false } }, "UserDataAccessViewSort" : { "name" : "sort", "in" : "query", "description" : "userDataAccessView sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,district_id,district_name,sup_group_code,region", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserDataAccessesFields" : { "name" : "fields", "in" : "query", "description" : "userDataAccesses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,application_id,emp_id,district_id,sup_group_code,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,all_districts,all_supgroups,attribute1,attribute2,attribute3,attribute4,attribute5,employee,application,dist" } }, "UserDataAccessesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserDataAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "UserDataAccessesSort" : { "name" : "sort", "in" : "query", "description" : "userDataAccesses sort order (csv)", "schema" : { "type" : "string", "example" : "id,application_id,emp_id,district_id,sup_group_code,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,all_districts,all_supgroups,attribute1,attribute2,attribute3,attribute4,attribute5,employee,application,dist", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserDataAccessesInclude" : { "name" : "include", "in" : "query", "description" : "userDataAccesses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,Applications,Districts" } }, "UserEmployeeAccessesFields" : { "name" : "fields", "in" : "query", "description" : "userEmployeeAccesses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,action,reason,estimated_return_date,accessing_emp_id" } }, "UserEmployeeAccessesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserEmployeeAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "UserEmployeeAccessesSort" : { "name" : "sort", "in" : "query", "description" : "userEmployeeAccesses sort order (csv)", "schema" : { "type" : "string", "example" : "id,emp_id,emp_type,legal_name,legal_name_last,legal_name_first,job_code,position,email,active_status,effective_date,sup_group_id,sup_group_code,sup_emp_id,supervisor,district_id,district,district_abbr,state,region,eff_sup_group_id,eff_sup_group_code,eff_sup_emp_id,eff_supervisor,eff_district_id,eff_district,eff_district_abbr,eff_state,eff_region,exclusion_code,created_on,created_by,last_updated_on,last_updated_by,action,reason,estimated_return_date,accessing_emp_id", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserEmployeeAccessesInclude" : { "name" : "include", "in" : "query", "description" : "userEmployeeAccesses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UserLoginsInclude" : { "name" : "include", "in" : "query", "description" : "userLogins relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees" } }, "UserLoginsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserLoginsIdResourceAttribute", "exampleSetFlag" : false } }, "UserLoginsFields" : { "name" : "fields", "in" : "query", "description" : "userLogins fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,session_id,application_id,employee_id,login_date,browser_name,major_version,minor_version,user_platform,screen_height,screen_width,attribute1,attribute2,attribute3,attribute4,attribute5,employee" } }, "UserLoginsSort" : { "name" : "sort", "in" : "query", "description" : "userLogins sort order (csv)", "schema" : { "type" : "string", "example" : "id,session_id,application_id,employee_id,login_date,browser_name,major_version,minor_version,user_platform,screen_height,screen_width,attribute1,attribute2,attribute3,attribute4,attribute5,employee", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserPermissionsInclude" : { "name" : "include", "in" : "query", "description" : "userPermissions relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UserPermissionsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserPermissionsIdResourceAttribute", "exampleSetFlag" : false } }, "UserPermissionsSort" : { "name" : "sort", "in" : "query", "description" : "userPermissions sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_permission_id,cp_user_id,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserPermissionsFields" : { "name" : "fields", "in" : "query", "description" : "userPermissions fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_permission_id,cp_user_id,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by" } }, "UserProfilesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserProfilesIdResourceAttribute", "exampleSetFlag" : false } }, "UserProfilesInclude" : { "name" : "include", "in" : "query", "description" : "userProfiles relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UserProfilesSort" : { "name" : "sort", "in" : "query", "description" : "userProfiles sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_user_name,first_name,last_name,middle_name,preferred_name,email_address,mobile_phone,password_date,last_updated_on,last_updated_by,last_logged_on", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserProfilesFields" : { "name" : "fields", "in" : "query", "description" : "userProfiles fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_user_name,first_name,last_name,middle_name,preferred_name,email_address,mobile_phone,cp_password,password_date,last_updated_on,last_updated_by,last_logged_on" } }, "UserRequestsSort" : { "name" : "sort", "in" : "query", "description" : "userRequests sort order (csv)", "schema" : { "type" : "string", "example" : "id,session_id,user_id,request_user,request_method,request_url,request_query_string,request_x_real_ip,request_user_agent,request_content_type,request_header_crnk_compact,browser_name,major_version,user_platform,request_time_ms,response_status,response_content_type,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserRequestsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserRequestsIdResourceAttribute", "exampleSetFlag" : false } }, "UserRequestsFields" : { "name" : "fields", "in" : "query", "description" : "userRequests fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,session_id,user_id,request_user,request_method,request_url,request_query_string,request_x_real_ip,request_user_agent,request_content_type,request_header_crnk_compact,browser_name,major_version,user_platform,request_time_ms,response_status,response_content_type,attribute1,attribute2,attribute3,attribute4,attribute5,created_on,created_by" } }, "UserRequestsInclude" : { "name" : "include", "in" : "query", "description" : "userRequests relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UserRoleAssignmentsSort" : { "name" : "sort", "in" : "query", "description" : "userRoleAssignments sort order (csv)", "schema" : { "type" : "string", "example" : "id,peoplesoft_id,role_id,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,usrRole", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserRoleAssignmentsInclude" : { "name" : "include", "in" : "query", "description" : "userRoleAssignments relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "UsrRoles" } }, "UserRoleAssignmentsFields" : { "name" : "fields", "in" : "query", "description" : "userRoleAssignments fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,peoplesoft_id,role_id,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,usrRole" } }, "UserRoleAssignmentsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserRoleAssignmentsIdResourceAttribute", "exampleSetFlag" : false } }, "UserRolesSort" : { "name" : "sort", "in" : "query", "description" : "userRoles sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,roleAccesses", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserRolesFields" : { "name" : "fields", "in" : "query", "description" : "userRoles fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,effective_start_date,effective_end_date,created_on,created_by,last_updated_on,last_updated_by,roleAccesses" } }, "UserRolesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserRolesIdResourceAttribute", "exampleSetFlag" : false } }, "UserRolesInclude" : { "name" : "include", "in" : "query", "description" : "userRoles relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "RoleAccesses" } }, "UserStatesFields" : { "name" : "fields", "in" : "query", "description" : "userStates fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_user_id,cp_user_name,state" } }, "UserStatesSort" : { "name" : "sort", "in" : "query", "description" : "userStates sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_user_id,cp_user_name,state", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UserStatesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UserStatesIdResourceAttribute", "exampleSetFlag" : false } }, "UserStatesInclude" : { "name" : "include", "in" : "query", "description" : "userStates relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UsersInclude" : { "name" : "include", "in" : "query", "description" : "users relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Sessions,UserAccesses,CustomerAccounts,CustomerContracts" } }, "UsersFields" : { "name" : "fields", "in" : "query", "description" : "users fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,cp_user_name,first_name,last_name,middle_name,preferred_name,active,eff_start_date,eff_end_date,email_address,cp_password,cp_admin,created_on,created_by,last_updated_on,last_updated_by,mobile_phone,receive_notifications,last_logged_on,logo_id,show_tickets,show_damages,show_managed_services,password_date,nda_signed,show_history,show_responses,show_screenshots,show_gps,expiration_cycle,export_gps,attachments_with_notifications,managed_services,ms_admin,account_admin,account_domains,allow_exports,sessions,userAccesses,customerAccounts,customerContracts,display_name" } }, "UsersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UsersIdResourceAttribute", "exampleSetFlag" : false } }, "UsersSort" : { "name" : "sort", "in" : "query", "description" : "users sort order (csv)", "schema" : { "type" : "string", "example" : "id,cp_user_name,first_name,last_name,middle_name,preferred_name,active,eff_start_date,eff_end_date,email_address,cp_admin,created_on,created_by,last_updated_on,last_updated_by,mobile_phone,receive_notifications,last_logged_on,logo_id,show_tickets,show_damages,show_managed_services,password_date,nda_signed,show_history,show_responses,show_screenshots,show_gps,expiration_cycle,export_gps,attachments_with_notifications,managed_services,ms_admin,account_admin,account_domains,allow_exports,sessions,userAccesses,customerAccounts,customerContracts,display_name", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UsicContactsInclude" : { "name" : "include", "in" : "query", "description" : "usicContacts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "CpDistricts" } }, "UsicContactsFields" : { "name" : "fields", "in" : "query", "description" : "usicContacts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,district_id,district_state,address_line1,address_line2,address_line3,city,state,country,dm_name,dm_email,dm_phone_no,hr,hr_phone_no,rd_name,rd_phone_no,rd_email,it_support,it_support_phone_no,sales_contact,sales_phone_no,sales_email,general_contact,general_phone_no,general_email,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by,cpDistrict" } }, "UsicContactsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UsicContactsIdResourceAttribute", "exampleSetFlag" : false } }, "UsicContactsSort" : { "name" : "sort", "in" : "query", "description" : "usicContacts sort order (csv)", "schema" : { "type" : "string", "example" : "id,district_id,district_state,address_line1,address_line2,address_line3,city,state,country,dm_name,dm_email,dm_phone_no,hr,hr_phone_no,rd_name,rd_phone_no,rd_email,it_support,it_support_phone_no,sales_contact,sales_phone_no,sales_email,general_contact,general_phone_no,general_email,eff_start_date,eff_end_date,created_on,created_by,last_updated_on,last_updated_by,cpDistrict", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UsrRolesFields" : { "name" : "fields", "in" : "query", "description" : "usrRoles fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by" } }, "UsrRolesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UsrRolesIdResourceAttribute", "exampleSetFlag" : false } }, "UsrRolesInclude" : { "name" : "include", "in" : "query", "description" : "usrRoles relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UsrRolesSort" : { "name" : "sort", "in" : "query", "description" : "usrRoles sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UsrsFields" : { "name" : "fields", "in" : "query", "description" : "usrs fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,prin_type,displayname,billing_id,loginname,firstname,lastname,reportingnode,activeuser,password_expires,last_sync_date,employee_number,timesheet_start_date,timesheet_end_date,default_project_id,reports_to_id,login_for_customer_id,email,department_number,storage_id,phone,title,home_phone,password_lockout,password_crypt,failed_logins,district_number,work_area,peoplesoft_id,supervisor_group_id,effective_district_id,effective_supervisor_group_id,district_id,truck_number,at_risk,type,user_status,certified,callout_format,last_six_ssn,org_super_region_id,org_region_id,communication_preference,hr_manager,continous_service_date,recent_hire_date,workday_district_code,workday_region,workday_super_region,dueDateExtensions,buckets,reportsTo,tkpDistrict" } }, "UsrsInclude" : { "name" : "include", "in" : "query", "description" : "usrs relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "DueDateExtensions,Buckets,Usrs,TkpDistricts" } }, "UsrsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UsrsIdResourceAttribute", "exampleSetFlag" : false } }, "UsrsSort" : { "name" : "sort", "in" : "query", "description" : "usrs sort order (csv)", "schema" : { "type" : "string", "example" : "id,prin_type,displayname,billing_id,loginname,firstname,lastname,reportingnode,activeuser,password_expires,last_sync_date,employee_number,timesheet_start_date,timesheet_end_date,default_project_id,reports_to_id,login_for_customer_id,email,department_number,storage_id,phone,title,home_phone,password_lockout,password_crypt,failed_logins,district_number,work_area,peoplesoft_id,supervisor_group_id,effective_district_id,effective_supervisor_group_id,district_id,truck_number,at_risk,type,user_status,certified,callout_format,last_six_ssn,org_super_region_id,org_region_id,communication_preference,hr_manager,continous_service_date,recent_hire_date,workday_district_code,workday_region,workday_super_region,dueDateExtensions,buckets,reportsTo,tkpDistrict", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UtilitiesInclude" : { "name" : "include", "in" : "query", "description" : "utilities relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "TkpCustomers" } }, "UtilitiesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UtilitiesIdResourceAttribute", "exampleSetFlag" : false } }, "UtilitiesSort" : { "name" : "sort", "in" : "query", "description" : "utilities sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,abbrev,customer_id,office_id,screen_bucket_id,require_area,app_key,signature_requirement,facility_type,service_list_id,auto_close,export_billing,has_gis_data,require_certificate,require_reschedule,require_eta,qc_bucket_id,drawing_abbrev,proximity_code,contract_number,contract_name,require_manual_time,hp_scoring,exclude_holdoff,require_academy_certificate,tkpCustomer", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UtilitiesFields" : { "name" : "fields", "in" : "query", "description" : "utilities fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,abbrev,customer_id,office_id,screen_bucket_id,require_area,app_key,signature_requirement,facility_type,service_list_id,auto_close,export_billing,has_gis_data,require_certificate,require_reschedule,require_eta,qc_bucket_id,drawing_abbrev,proximity_code,contract_number,contract_name,require_manual_time,hp_scoring,exclude_holdoff,require_academy_certificate,tkpCustomer" } }, "UtilitiesProfilesInclude" : { "name" : "include", "in" : "query", "description" : "utilitiesProfiles relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "UtilitiesProfilesSort" : { "name" : "sort", "in" : "query", "description" : "utilitiesProfiles sort order (csv)", "schema" : { "type" : "string", "example" : "id,facility_type,facility_type_id,utility_type,utility_type_id,facility,facility_id", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UtilitiesProfilesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UtilitiesProfilesIdResourceAttribute", "exampleSetFlag" : false } }, "UtilitiesProfilesFields" : { "name" : "fields", "in" : "query", "description" : "utilitiesProfiles fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,facility_type,facility_type_id,utility_type,utility_type_id,facility,facility_id" } }, "UtilityandFacilitiesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UtilityandFacilitiesIdResourceAttribute", "exampleSetFlag" : false } }, "UtilityandFacilitiesSort" : { "name" : "sort", "in" : "query", "description" : "utilityandFacilities sort order (csv)", "schema" : { "type" : "string", "example" : "id,item_name,item_type,active_flag,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "UtilityandFacilitiesFields" : { "name" : "fields", "in" : "query", "description" : "utilityandFacilities fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,item_name,item_type,active_flag,created_on,created_by,last_updated_on,last_updated_by" } }, "UtilityandFacilitiesInclude" : { "name" : "include", "in" : "query", "description" : "utilityandFacilities relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "VehiclesInclude" : { "name" : "include", "in" : "query", "description" : "vehicles relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Employees,EmployeesOnLoan,EmployeesActiveMultipleItAssets,EmployeesActiveNoAssets" } }, "VehiclesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/VehiclesIdResourceAttribute", "exampleSetFlag" : false } }, "VehiclesFields" : { "name" : "fields", "in" : "query", "description" : "vehicles fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "cvn,id,employee_id,model_year,make,model_group,vin_number,book_value,license_plate_number,created_on,created_by,last_updated_on,last_updated_by,employee,employeeOnLoan,employeesActiveMultipleItAssets,employeesActiveNoAsset" } }, "VehiclesSort" : { "name" : "sort", "in" : "query", "description" : "vehicles sort order (csv)", "schema" : { "type" : "string", "example" : "cvn,id,employee_id,model_year,make,model_group,vin_number,book_value,license_plate_number,created_on,created_by,last_updated_on,last_updated_by,employee,employeeOnLoan,employeesActiveMultipleItAssets,employeesActiveNoAsset", "exampleSetFlag" : true, "types" : [ "string" ] } }, "VerizonWirelessInventoriesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoriesIdResourceAttribute", "exampleSetFlag" : false } }, "VerizonWirelessInventoriesInclude" : { "name" : "include", "in" : "query", "description" : "verizonWirelessInventories relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "VerizonWirelessInventorySfos" } }, "VerizonWirelessInventoriesSort" : { "name" : "sort", "in" : "query", "description" : "verizonWirelessInventories sort order (csv)", "schema" : { "type" : "string", "example" : "cost_center,ecpd,customer_id,bill_acc_num,bill_cycle_id,iccid,esn,id,ip,pplan_id,pplan_desc,device_make,device_model,cust_mtn_stat,reason_code,activation_date,upgrade_elig_date,last_upgrade_date,suspn_deactv_dt,mtn_stat_eff_date,auto_reconn_date,ip_pool_name,bsns_id,given_nme,mdl_init,family_nme,ccntrct_end_dt,pplan_cost,min,ccntrct_start_dt,current_dvcid,sfo_code_cnt,last_updated_on,listSfos,verizonWirelessInventorySfos", "exampleSetFlag" : true, "types" : [ "string" ] } }, "VerizonWirelessInventoriesFields" : { "name" : "fields", "in" : "query", "description" : "verizonWirelessInventories fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "cost_center,ecpd,customer_id,bill_acc_num,bill_cycle_id,iccid,esn,id,ip,pplan_id,pplan_desc,device_make,device_model,cust_mtn_stat,reason_code,activation_date,upgrade_elig_date,last_upgrade_date,suspn_deactv_dt,mtn_stat_eff_date,auto_reconn_date,ip_pool_name,bsns_id,given_nme,mdl_init,family_nme,ccntrct_end_dt,pplan_cost,min,ccntrct_start_dt,current_dvcid,sfo_code_cnt,last_updated_on,listSfos,verizonWirelessInventorySfos" } }, "VerizonWirelessInventorySfosPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventorySfosIdResourceAttribute", "exampleSetFlag" : false } }, "VerizonWirelessInventorySfosFields" : { "name" : "fields", "in" : "query", "description" : "verizonWirelessInventorySfos fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,mdn,sfo_code,sfo_description,last_updated_on,verizonWirelessInventory" } }, "VerizonWirelessInventorySfosSort" : { "name" : "sort", "in" : "query", "description" : "verizonWirelessInventorySfos sort order (csv)", "schema" : { "type" : "string", "example" : "id,mdn,sfo_code,sfo_description,last_updated_on,verizonWirelessInventory", "exampleSetFlag" : true, "types" : [ "string" ] } }, "VerizonWirelessInventorySfosInclude" : { "name" : "include", "in" : "query", "description" : "verizonWirelessInventorySfos relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "VerizonWirelessInventories" } }, "VerizonWirelessInventoryUsageSummariesSort" : { "name" : "sort", "in" : "query", "description" : "verizonWirelessInventoryUsageSummaries sort order (csv)", "schema" : { "type" : "string", "example" : "id,mdn,usage_date,acct_no,sub_acct_no,usage_minutes,usage_bytes,usage_sms,last_updated_on,verizonWirelessInventoryUsages", "exampleSetFlag" : true, "types" : [ "string" ] } }, "VerizonWirelessInventoryUsageSummariesFields" : { "name" : "fields", "in" : "query", "description" : "verizonWirelessInventoryUsageSummaries fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,mdn,usage_date,acct_no,sub_acct_no,usage_minutes,usage_bytes,usage_sms,last_updated_on,verizonWirelessInventoryUsages" } }, "VerizonWirelessInventoryUsageSummariesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsageSummariesIdResourceAttribute", "exampleSetFlag" : false } }, "VerizonWirelessInventoryUsageSummariesInclude" : { "name" : "include", "in" : "query", "description" : "verizonWirelessInventoryUsageSummaries relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "VerizonWirelessInventoryUsages" } }, "VerizonWirelessInventoryUsagesSort" : { "name" : "sort", "in" : "query", "description" : "verizonWirelessInventoryUsages sort order (csv)", "schema" : { "type" : "string", "example" : "id,acct_no,sub_acct_no,mdn,usage_date,usage_time,usage_type,usage_count,overseas_ind,incoming_direction_ind,dialed_digits,roaming_ind,roaming_provider,country_code,duration_time,sequence_num,data_type,filler,last_updated_on,verizonWirelessInventoryUsageSummary", "exampleSetFlag" : true, "types" : [ "string" ] } }, "VerizonWirelessInventoryUsagesFields" : { "name" : "fields", "in" : "query", "description" : "verizonWirelessInventoryUsages fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,acct_no,sub_acct_no,mdn,usage_date,usage_time,usage_type,usage_count,overseas_ind,incoming_direction_ind,dialed_digits,roaming_ind,roaming_provider,country_code,duration_time,sequence_num,data_type,filler,last_updated_on,verizonWirelessInventoryUsageSummary" } }, "VerizonWirelessInventoryUsagesInclude" : { "name" : "include", "in" : "query", "description" : "verizonWirelessInventoryUsages relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "VerizonWirelessInventoryUsageSummaries" } }, "VerizonWirelessInventoryUsagesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/VerizonWirelessInventoryUsagesIdResourceAttribute", "exampleSetFlag" : false } }, "ViolationStatusesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/ViolationStatusesIdResourceAttribute", "exampleSetFlag" : false } }, "ViolationStatusesFields" : { "name" : "fields", "in" : "query", "description" : "violationStatuses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,name,category,display_order,created_on,created_by,last_updated_on,last_updated_by" } }, "ViolationStatusesInclude" : { "name" : "include", "in" : "query", "description" : "violationStatuses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "ViolationStatusesSort" : { "name" : "sort", "in" : "query", "description" : "violationStatuses sort order (csv)", "schema" : { "type" : "string", "example" : "id,name,category,display_order,created_on,created_by,last_updated_on,last_updated_by", "exampleSetFlag" : true, "types" : [ "string" ] } }, "VisitLocationsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/VisitLocationsIdResourceAttribute", "exampleSetFlag" : false } }, "VisitLocationsFields" : { "name" : "fields", "in" : "query", "description" : "visitLocations fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,on_site,latitude,longitude,distance,source,visit" } }, "VisitLocationsSort" : { "name" : "sort", "in" : "query", "description" : "visitLocations sort order (csv)", "schema" : { "type" : "string", "example" : "id,on_site,latitude,longitude,distance,source,visit", "exampleSetFlag" : true, "types" : [ "string" ] } }, "VisitLocationsInclude" : { "name" : "include", "in" : "query", "description" : "visitLocations relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Visits" } }, "VisitsSort" : { "name" : "sort", "in" : "query", "description" : "visits sort order (csv)", "schema" : { "type" : "string", "example" : "id,ticket_id,arrived,departed,synced_up,when_saved_local,photo_ident,actor_id,opened,district_id,visitLocation,tkpDistrict,ticket,activities,dueDateExtensions", "exampleSetFlag" : true, "types" : [ "string" ] } }, "VisitsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/VisitsIdResourceAttribute", "exampleSetFlag" : false } }, "VisitsFields" : { "name" : "fields", "in" : "query", "description" : "visits fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,ticket_id,arrived,departed,synced_up,when_saved_local,photo_ident,actor_id,opened,district_id,visitLocation,tkpDistrict,ticket,activities,dueDateExtensions" } }, "VisitsInclude" : { "name" : "include", "in" : "query", "description" : "visits relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "VisitLocations,TkpDistricts,Tickets,Activities,DueDateExtensions" } }, "VotesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/VotesIdResourceAttribute", "exampleSetFlag" : false } }, "VotesInclude" : { "name" : "include", "in" : "query", "description" : "votes relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Ideas,Employees" } }, "VotesFields" : { "name" : "fields", "in" : "query", "description" : "votes fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,vote_type,idea_id,voter_id,created_on,created_by,last_updated_on,last_updated_by,idea,employee" } }, "VotesSort" : { "name" : "sort", "in" : "query", "description" : "votes sort order (csv)", "schema" : { "type" : "string", "example" : "id,vote_type,idea_id,voter_id,created_on,created_by,last_updated_on,last_updated_by,idea,employee", "exampleSetFlag" : true, "types" : [ "string" ] } }, "WfNotificationsFields" : { "name" : "fields", "in" : "query", "description" : "wfNotifications fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,process_id,activity_id,step_id,status_id,idType,id_column_table,owner,activity_name,text,created_on,created_by,last_updated_on,last_updated_by,next_step_url,idvalue,completed_date,result,wf_item_id,remarks,wfNotificationsArchives,policyDropOffEstimates" } }, "WfNotificationsSort" : { "name" : "sort", "in" : "query", "description" : "wfNotifications sort order (csv)", "schema" : { "type" : "string", "example" : "id,process_id,activity_id,step_id,status_id,idType,id_column_table,owner,activity_name,text,created_on,created_by,last_updated_on,last_updated_by,next_step_url,idvalue,completed_date,result,wf_item_id,remarks,wfNotificationsArchives,policyDropOffEstimates", "exampleSetFlag" : true, "types" : [ "string" ] } }, "WfNotificationsInclude" : { "name" : "include", "in" : "query", "description" : "wfNotifications relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "WfNotificationsArchives,PolicyDropOffEstimates" } }, "WfNotificationsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/WfNotificationsIdResourceAttribute", "exampleSetFlag" : false } }, "WfNotificationsArchivesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/WfNotificationsArchivesIdResourceAttribute", "exampleSetFlag" : false } }, "WfNotificationsArchivesFields" : { "name" : "fields", "in" : "query", "description" : "wfNotificationsArchives fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,notification_id,process_id,activity_id,step_id,status_id,idType,id_column_table,owner,activity_name,text,created_on,created_by,last_updated_on,last_updated_by,next_step_url,idvalue,completed_date,result,wf_item_id,remarks,archive_date,wfNotification" } }, "WfNotificationsArchivesInclude" : { "name" : "include", "in" : "query", "description" : "wfNotificationsArchives relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "WfNotifications" } }, "WfNotificationsArchivesSort" : { "name" : "sort", "in" : "query", "description" : "wfNotificationsArchives sort order (csv)", "schema" : { "type" : "string", "example" : "id,notification_id,process_id,activity_id,step_id,status_id,idType,id_column_table,owner,activity_name,text,created_on,created_by,last_updated_on,last_updated_by,next_step_url,idvalue,completed_date,result,wf_item_id,remarks,archive_date,wfNotification", "exampleSetFlag" : true, "types" : [ "string" ] } }, "WirelessInventoriesFields" : { "name" : "fields", "in" : "query", "description" : "wirelessInventories fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,wireless_number,wireless_vendor,wireless_user_full_name,wireless_user_status,district_id,employee_id,truck_vin,imei,sim_number,device_model,contract_end_date,data_usage,voice_usage,text_usage,total_charges,device_last_updated_on,usage_last_updated_on,dist,employee,employeeOnLoan" } }, "WirelessInventoriesSort" : { "name" : "sort", "in" : "query", "description" : "wirelessInventories sort order (csv)", "schema" : { "type" : "string", "example" : "id,wireless_number,wireless_vendor,wireless_user_full_name,wireless_user_status,district_id,employee_id,truck_vin,imei,sim_number,device_model,contract_end_date,data_usage,voice_usage,text_usage,total_charges,device_last_updated_on,usage_last_updated_on,dist,employee,employeeOnLoan", "exampleSetFlag" : true, "types" : [ "string" ] } }, "WirelessInventoriesInclude" : { "name" : "include", "in" : "query", "description" : "wirelessInventories relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Districts,Employees,EmployeesOnLoan" } }, "WirelessInventoriesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/WirelessInventoriesIdResourceAttribute", "exampleSetFlag" : false } }, "WsUserAccessesSort" : { "name" : "sort", "in" : "query", "description" : "wsUserAccesses sort order (csv)", "schema" : { "type" : "string", "example" : "id,token_id,namespace,classs,method,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,token", "exampleSetFlag" : true, "types" : [ "string" ] } }, "WsUserAccessesPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/WsUserAccessesIdResourceAttribute", "exampleSetFlag" : false } }, "WsUserAccessesInclude" : { "name" : "include", "in" : "query", "description" : "wsUserAccesses relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tokens" } }, "WsUserAccessesFields" : { "name" : "fields", "in" : "query", "description" : "wsUserAccesses fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,token_id,namespace,classs,method,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,token" } }, "WsUsersPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/WsUsersIdResourceAttribute", "exampleSetFlag" : false } }, "WsUsersInclude" : { "name" : "include", "in" : "query", "description" : "wsUsers relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "Tokens" } }, "WsUsersSort" : { "name" : "sort", "in" : "query", "description" : "wsUsers sort order (csv)", "schema" : { "type" : "string", "example" : "id,user_name,password,entity_name,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,token,new_password", "exampleSetFlag" : true, "types" : [ "string" ] } }, "WsUsersFields" : { "name" : "fields", "in" : "query", "description" : "wsUsers fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,user_name,password,entity_name,start_date,end_date,created_on,created_by,last_updated_on,last_updated_by,token,new_password" } }, "WsvLocByContractsPrimaryKey" : { "name" : "id", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/WsvLocByContractsIdResourceAttribute", "exampleSetFlag" : false } }, "WsvLocByContractsInclude" : { "name" : "include", "in" : "query", "description" : "wsvLocByContracts relationships to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "" } }, "WsvLocByContractsFields" : { "name" : "fields", "in" : "query", "description" : "wsvLocByContracts fields to include (csv)", "schema" : { "type" : "string", "exampleSetFlag" : false, "types" : [ "string" ], "default" : "id,oPENED_CT,cLOSED_CT,cAL_YEAR,cAL_MONTH,cAL_WEEK_YEAR,cAL_WEEK_IN_YEAR,cALENDAR_DATE,aCCOUNT_NAME,aCCOUNT_NUMBER,cONTRACT_NUMBER,rOW_CHECKSUM,cREATED_DTTM" } }, "WsvLocByContractsSort" : { "name" : "sort", "in" : "query", "description" : "wsvLocByContracts sort order (csv)", "schema" : { "type" : "string", "example" : "id,oPENED_CT,cLOSED_CT,cAL_YEAR,cAL_MONTH,cAL_WEEK_YEAR,cAL_WEEK_IN_YEAR,cALENDAR_DATE,aCCOUNT_NAME,aCCOUNT_NUMBER,cONTRACT_NUMBER,rOW_CHECKSUM,cREATED_DTTM", "exampleSetFlag" : true, "types" : [ "string" ] } } }, "securitySchemes" : { "JWT" : { "type" : "HTTP", "description" : "Provide JWT token returned from `/auth`", "name" : "Authorization", "in" : "HEADER", "scheme" : "bearer", "bearerFormat" : "JWT" } } } }